Set with associatex indexes.

Indexable class defines objects that can be members of IxSet.

Function to be used for calcs in inferIxSet when you don't want any calculated values.

Template Haskell helper function for automatically building an Indexable instance from a data type, e.g.

 data Foo = Foo Int String

and

 $(inferIxSet "FooDB" ''Foo 'noCalcs [''Int,''String])

will build a type synonym

 type FooDB = IxSet Foo

with Int and String as indexes.

WARNING: The type specified as the first index must be a type which appears in all values in the IxSet or toList, toSet and serialization will not function properly. You will be warned not to do this by runtime error. You can always use the element type itself. For example:

 $(inferIxSet "FooDB" ''Foo 'noCalcs [''Foo, ''Int, ''String])

Create an IxSet using a list of indexes. Useful in Indexable empty method. Use ixFun and ixGen as list elements.

 instance Indexable Type where
     empty = ixSet [ ...
                     ixFun getIndex1
                     ixGen (Proxy :: Proxy Index2Type)
                   ]

First index in the list must contain all objects in set, doing otherwise result in runtime error.

Create a functional index. Provided function should return a list of indexes where value should be found.

 getIndexes value = [...indexes...]

 instance Indexable Type where
     empty = ixSet [ ixFun getIndexes ]

This is the recommended way to create indexes.

Create a generic index. Provided example is used only as type source so you may use a Proxy. The ixGen uses flatten to traverse value using its Data instance.

 instance Indexable Type where
     empty = ixSet [ ixGen (Proxy :: Proxy Type) ]

In production systems consider using ixFun in place of ixGen as the former one is much faster.

Higher order operator for modifying IxSets. Use this when your final function should have the form a -> IxSet a -> IxSet a, e.g. insert or delete.

Inserts an item into the IxSet. If your data happens to have primary key this function might not be what you want. See updateIx.

Removes an item from the IxSet.

Will replace the item with index k. Only works if there is at most one item with that index in the IxSet. Will not change IxSet if you have more then 1 item with given index.

Will delete the item with index k. Only works if there is at most one item with that index in the IxSet. Will not change IxSet if you have more then 1 item with given index.

Converts a Set to an IxSet.

Converts a list to an IxSet.

Converts an IxSet to a Set of its elements.

Converts an IxSet to its list of elements.

Converts an IxSet to its list of elements.

List will be sorted in ascending order by the index k.

The list may contain duplicate entries if a single value produces multiple keys.

Converts an IxSet to its list of elements.

List will be sorted in descending order by the index k.

The list may contain duplicate entries if a single value produces multiple keys.

If the IxSet is a singleton it will return the one item stored in it. If IxSet is empty or has many elements this function returns Nothing.

Like getOne with a user provided default.

Returns the number of unique items in the IxSet.

Return True if the IxSet is empty, False otherwise.

An infix intersection operation.

An infix union operation.

Takes the union of the two IxSets.

Takes the intersection of the two IxSets.

Infix version of getEQ.

Infix version of getLT.

Infix version of getGT.

Infix version of getLTE.

Infix version of getGTE.

Returns the subset with indexes in the open interval (k,k).

Returns the subset with indexes in [k,k).

Returns the subset with indexes in (k,k].

Returns the subset with indexes in [k,k].

Creates the subset that has an index in the provided list.

Creates the subset that matches all the provided indexes.

Returns the subset with an index equal to the provided key. The set must be indexed over key type, doing otherwise results in runtime error.

Returns the subset with an index less than the provided key. The set must be indexed over key type, doing otherwise results in runtime error.

Returns the subset with an index greater than the provided key. The set must be indexed over key type, doing otherwise results in runtime error.

Returns the subset with an index less than or equal to the provided key. The set must be indexed over key type, doing otherwise results in runtime error.

Returns the subset with an index greater than or equal to the provided key. The set must be indexed over key type, doing otherwise results in runtime error.

Returns the subset with an index within the interval provided. The bottom of the interval is closed and the top is open, i. e. [k1;k2). The set must be indexed over key type, doing otherwise results in runtime error.

Returns lists of elements paired with the indexes determined by type inference.

Returns lists of elements paired with the indexes determined by type inference.

The resulting list will be sorted in ascending order by k. The values in '[t]' will be sorted in ascending order as well.

Returns lists of elements paired with the indexes determined by type inference.

The resulting list will be sorted in descending order by k.

NOTE: The values in '[t]' are currently sorted in ascending order. But this may change if someone bothers to add toDescList. So do not rely on the sort order of '[t]'.

Generically traverses the argument to find all occurences of values of type b and returns them as a list.

This function properly handles String as String not as [Char].

Generically traverses the argument and calculated values to find all occurences of values of type b and returns them as a list. Equivalent to:

 flatten (x,calcs x)

This function properly handles String as String not as [Char].

Statistics about IxSet. This function returns quadruple consisting of 1. total number of elements in the set 2. number of declared indexes 3. number of keys in all indexes 4. number of values in all keys in all indexes. This can aid you in debugging and optimisation.