Report a bug
If you spot a problem with this page, click here to create a GitHub issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using a local clone.

mir.string_map

Ordered string-value associtaive array

enum auto isStringMap(T);
Checks if the type is instance of StringMap.
Examples:
static assert(isStringMap!(StringMap!int));
static assert(isStringMap!(const StringMap!int));
static assert(!isStringMap!int);
struct StringMap(T, U = uint) if (isMutable!T && !__traits(hasMember, T, "opPostMove") && __traits(isUnsigned, U));
Ordered string-value associtaive array with extremely fast lookup.
Parameters:
T mutable value type, can be instance of Algebraic  for example.
U an unsigned type that can hold an index of keys. U.max must be less then the maximum possible number of struct members.
Examples:
StringMap!int table;
table["L"] = 3;
table["A"] = 2;
table["val"] = 1;
assert(table.keys == ["L", "A", "val"]);
assert(table.values == [3, 2, 1]);
assert(table["A"] == 2);
table.values[2] += 10;
assert(table["A"] == 2);
assert(table["L"] == 3);
assert(table["val"] == 11);
assert(table.keys == ["L", "A", "val"]);
assert(table.values == [3, 2, 11]);
table.remove("A");
assert(table.keys == ["L", "val"]);
assert(table.values == [3, 11]);
assert(table["L"] == 3);
assert(table["val"] == 11);
pure nothrow @nogc ref @safe auto opAssign()(typeof(null)) return;
Reset the associtave array
Examples:
StringMap!int map = ["key" : 1];
map = null;
pure nothrow @nogc @safe this()(typeof(null) aa);
Initialize the associtave array with default value.
Examples:
Usefull for default funcion argument.
StringMap!int map = null; //
pure nothrow @trusted this()(T[string] aa);
Constructs an associative array using keys and values from the builtin associative array

Complexity O(n log(n))

Examples:
StringMap!int map = ["key" : 1];
assert(map.findPos("key") == 0);
pure nothrow @trusted this()(string[] keys, T[] values);
Constructs an associative array using keys and values.
Parameters:
string[] keys mutable array of keys
T[] values mutable array of values Key and value arrays must have the same length.

Complexity O(n log(n))

Examples:
auto keys = ["ba", "a"];
auto values = [1.0, 3.0];
auto map = StringMap!double(keys, values);
assert(map.keys is keys);
assert(map.values is values);
const pure nothrow @nogc @property @safe size_t length()();
Returns:
number of elements in the table.
Examples:
StringMap!double map;
assert(map.length == 0);
map["a"] = 3.0;
assert(map.length == 1);
map["c"] = 4.0;
assert(map.length == 2);
assert(map.remove("c"));
assert(map.length == 1);
assert(!map.remove("c"));
assert(map.length == 1);
assert(map.remove("a"));
assert(map.length == 0);
const pure nothrow @nogc @property @safe const(string)[] keys()();
Returns a dynamic array, the elements of which are the keys in the associative array. Doesn't allocate a new copy.

Complexity O(1)

Examples:
StringMap!double map;
assert(map.keys == []);
map["c"] = 4.0;
assert(map.keys == ["c"]);
map["a"] = 3.0;
assert(map.keys == ["c", "a"]);
map.remove("c");
assert(map.keys == ["a"]);
map.remove("a");
assert(map.keys == []);
map["c"] = 4.0;
assert(map.keys == ["c"]);
inout pure nothrow @nogc @property @safe inout(T)[] values()();
Returns a dynamic array, the elements of which are the values in the associative array. Doesn't allocate a new copy.

Complexity O(1)

Examples:
StringMap!double map;
assert(map.values == []);
map["c"] = 4.0;
assert(map.values == [4.0]);
map["a"] = 3.0;
assert(map.values == [4.0, 3.0]);
map.values[0]++;
assert(map.values == [5.0, 3.0]);
map.remove("c");
assert(map.values == [3.0]);
map.remove("a");
assert(map.values == []);
map["c"] = 4.0;
assert(map.values == [4.0]);
const pure nothrow @property @safe size_t capacity()();
(Property) Gets the current capacity of an associative array. The capacity is the size that the underlaynig slices can grow to before the underlying arrays may be reallocated or extended.

Complexity O(1)

Examples:
StringMap!double map;
assert(map.capacity == 0);
map["c"] = 4.0;
assert(map.capacity >= 1);
map["a"] = 3.0;
assert(map.capacity >= 2);
map.remove("c");
map.assumeSafeAppend;
assert(map.capacity >= 2);
pure nothrow @trusted size_t reserve()(size_t newcapacity);
Reserves capacity for an associative array. The capacity is the size that the underlaying slices can grow to before the underlying arrays may be reallocated or extended.
Examples:
StringMap!double map;
auto capacity = map.reserve(10);
assert(capacity >= 10);
assert(map.capacity == capacity);
map["c"] = 4.0;
assert(map.capacity == capacity);
map["a"] = 3.0;
assert(map.capacity >= 2);
assert(map.remove("c"));
capacity = map.reserve(20);
assert(capacity >= 20);
assert(map.capacity == capacity);
inout nothrow ref @system inout(typeof(this)) assumeSafeAppend()() return;
Assume that it is safe to append to this associative array. Appends made to this associative array after calling this function may append in place, even if the array was a slice of a larger array to begin with. Use this only when it is certain there are no elements in use beyond the associative array in the memory block. If there are, those elements will be overwritten by appending to this associative array.

Warning Calling this function, and then using references to data located after the given associative array results in undefined behavior.

Returns:
The input is returned.
Examples:
StringMap!double map;
map["c"] = 4.0;
map["a"] = 3.0;
assert(map.capacity >= 2);
map.remove("c");
assert(map.capacity == 0);
map.assumeSafeAppend;
assert(map.capacity >= 2);
pure nothrow @nogc @safe void clear()();
Removes all remaining keys and values from an associative array.

Complexity O(1)

Examples:
StringMap!double map;
map["c"] = 4.0;
map["a"] = 3.0;
map.clear;
assert(map.length == 0);
assert(map.capacity == 0);
map.assumeSafeAppend;
assert(map.capacity >= 2);
pure nothrow @nogc @trusted bool remove()(scope const(char)[] key);
remove(key) does nothing if the given key does not exist and returns false. If the given key does exist, it removes it from the AA and returns true.

Complexity O(log(s)) (not exist) or O(n) (exist), where s is the count of the strings with the same length as they key.

Examples:
StringMap!double map;
map["a"] = 3.0;
map["c"] = 4.0;
assert(map.remove("c"));
assert(!map.remove("c"));
assert(map.remove("a"));
assert(map.length == 0);
assert(map.capacity == 0);
assert(map.assumeSafeAppend.capacity >= 2);
const pure nothrow @nogc @trusted ptrdiff_t findPos()(scope const(char)[] key);
Finds position of the key in the associative array .

Return An index starting from 0 that corresponds to the key or -1 if the associative array doesn't contain the key.

Complexity O(log(s)), where s is the number of the keys with the same length as the input key.

Examples:
StringMap!double map;
map["c"] = 3.0;
map["La"] = 4.0;
map["a"] = 5.0;

assert(map.findPos("C") == -1);
assert(map.findPos("c") == 0);
assert(map.findPos("La") == 1);
assert(map.findPos("a") == 2);

map.remove("c");

assert(map.findPos("c") == -1);
assert(map.findPos("La") == 0);
assert(map.findPos("a") == 1);
inout pure nothrow @nogc @system inout(T)* opBinaryRight(string op : "in")(scope const(char)[] key);

Complexity O(log(s)), where s is the number of the keys with the same length as the input key.

Examples:
StringMap!double map;
assert(("c" in map) is null);
map["c"] = 3.0;
assert(*("c" in map) == 3.0);
inout pure ref @trusted inout(T) opIndex()(scope const(char)[] key);

Complexity O(log(s)), where s is the number of the keys with the same length as the input key.

Examples:
StringMap!double map;
map["c"] = 3.0;
map["La"] = 4.0;
map["a"] = 5.0;

map["La"] += 10;
assert(map["La"] == 14.0);
pure nothrow ref @trusted T opIndexAssign()(T value, string key);

Complexity O(log(s)) (exist) or O(n) (not exist), where s is the count of the strings with the same length as they key.

inout(T) get()(scope const(char)[] key, lazy inout(T) defaultValue);
Looks up key; if it exists returns corresponding value else evaluates and returns defaultValue.

Complexity O(log(s)), where s is the number of the keys with the same length as the input key.

Examples:
StringMap!int map;
map["c"] = 3;
assert(map.get("c", 1) == 3);
assert(map.get("C", 1) == 1);
ref T require()(string key, lazy T value = T.init);
Looks up key; if it exists returns corresponding value else evaluates value, adds it to the associative array and returns it.

Complexity O(log(s)) (exist) or O(n) (not exist), where s is the count of the strings with the same length as they key.

Examples:
StringMap!int map = ["aa": 1];
int add3(ref int x) { x += 3; return x; }
assert(add3(map.require("aa", 10)) == 4);
assert(add3(map.require("bb", 10)) == 13);
assert(map.require("a", 100));
assert(map.require("aa") == 4);
assert(map.require("bb") == 13);
assert(map.keys == ["aa", "bb", "a"]);
template toAA()
Converts the associtave array to a common Dlang associative array.

Complexity O(n).

Examples:
StringMap!int map = ["k": 1];
int[string] aa = map.toAA;
assert(aa["k"] == 1);
const T[string] toAA()();