Indexed

View Source Indexed.UniquesBundle (Indexed v0.3.4)

A piece of data defining unique values of a field under a prefilter.

It tracks similar data in two ways. A map is tracked with each unique value found as keys and the number of occurrences found in the data set as vals. This is useful for quick updates to the data, while the second piece of data mainained, a list of the map's keys, is a handy, ascending-sorted list of these values.

Link to this section Summary

Types

counts_map()

Occurrences of each value (map key) under a prefilter.

event()

Indicates that a value was added or removed from the bundle's list.

t()

A 3-element tuple defines unique values under a prefilter

Functions

add(arg, value)

Add a value to the uniques bundle.

get(index, entity_name, prefilter, field_name)
new(counts_map \\ %{}, list \\ [], events \\ [], last_instance_removed? \\ false)

Create a new uniques bundle.

put(bundle, index_ref, entity_name, prefilter, field_name, opts \\ [])

Store unique values for a field in a prefilter (as a list and map).

remove(arg, value)

Remove value from the uniques bundle.

Link to this section Types

Link to this type

counts_map()

View Source 
@type counts_map() :: %{required(any()) => non_neg_integer()}

Occurrences of each value (map key) under a prefilter.

Link to this type

event()

View Source 
@type event() :: {:add, any()} | {:rm, any()}

Indicates that a value was added or removed from the bundle's list.

Link to this type

t()

View Source 
@type t() ::
  {counts_map(), list :: [any()] | nil, events :: [event()],
   last_instance_removed? :: boolean()}

A 3-element tuple defines unique values under a prefilter:

  1. Map of discrete values to their occurrence counts.
  2. List of discrete values. (Keys of #1's map.)
  3. A list of events which occurred when processing the bundle.
  4. A boolean which is true when remove/2 is used and it has taken the last remaining instance of the given value.

Link to this section Functions

Link to this function

add(arg, value)

View Source 
@spec add(t(), any()) :: t()

Add a value to the uniques bundle.

Link to this function

get(index, entity_name, prefilter, field_name)

View Source 
@spec get(Indexed.t(), atom(), Indexed.prefilter(), atom()) :: t()
Link to this function

new(counts_map \\ %{}, list \\ [], events \\ [], last_instance_removed? \\ false)

View Source 
@spec new(counts_map(), [any()] | nil, [event()], boolean()) :: t()

Create a new uniques bundle.

Link to this function

put(bundle, index_ref, entity_name, prefilter, field_name, opts \\ [])

View Source 
@spec put(t(), :ets.tid(), atom(), Indexed.prefilter(), atom(), keyword()) :: t()

Store unique values for a field in a prefilter (as a list and map).

If the :new? option is true, then the bundle will be inserted for sure.

Link to this function

remove(arg, value)

View Source 
@spec remove(t(), any()) :: t()

Remove value from the uniques bundle.