Array (elixir_array v2.1.0)

A wrapper module for Erlang's array.

Link to this section Summary

Functions

default(array)

Gets the value used for uninitialized entries.

equal?(array1, array2)

Check if two arrays are equal using ===.

fetch(arr, idx)

Access behavior fetch/2 callback.

fix(arr)

Fixes the size of the array. This prevents it from growing automatically upon insertion.

foldl(array, acc, fun)

Folds the elements of the array using the given function and initial accumulator value. The elements are visited in order from the lowest index to the highest.

foldr(array, acc, fun)

Folds the elements of the array right-to-left using the given function and initial accumulator value. The elements are visited in order from the highest index to the lowest.

from_erlang_array(erl_arr)

Converts an Erlang's array to an array. All properties (size, elements, default value, fixedness) of the original array are preserved.

from_list(list)

Equivalent to from_list(list, nil).

from_list(list, default)

Converts a list to an extendible array. default is used as the value for uninitialized entries of the array.

from_orddict(orddict)

Equivalent to from_orddict(orddict, nil).

from_orddict(orddict, default)

Converts an ordered list of pairs {index, value} to a corresponding extendible array. default is used as the value for uninitialized entries of the array.

get(array, idx)

Gets the value of entry idx. If idx is not a nonnegative integer, or if the array has fixed size and idx is larger than the maximum index, the call raises ArgumentError.

get(arr, idx, value)

Access behavior get/3 callback

get_and_update(arr, idx, fun)

Access behavior get_and_update/3 callback

is_array(arr)

Returns true if arr appears to be an array, otherwise false. Note that the check is only shallow; there is no guarantee that arr is a well-formed array representation even if this function returns true.

is_fix(array)

Checks if the array has fixed size. Returns true if the array is fixed, otherwise false.

map(arr, fun)

Maps the given function onto each element of the array. The elements are visited in order from the lowest index to the highest.

new()

Creates a new, extendible array with initial size zero. The default value is the atom nil, not undefined.

new(options)

Creates a new fixed array according to the given options. By default, the array is extendible and has initial size zero. The default value is the atom nil, if not specified.

pop(arr, idx)

Access behavior pop/2 callback

relax(arr)

Makes the array resizable.

reset(arr, idx)

Resets entry idx to the default value for the array. If the value of entry idx is the default value the array will be returned unchanged. Reset will never change size of the array. Shrinking can be done explicitly by calling resize/2.

resize(arr)

Changes the size of the array to that reported by sparse_size/1. If the given array has fixed size, the resulting array will also have fixed size.

resize(arr, size)

Changes the size of the array. If size is not a nonnegative integer, the call raises ArgumentError. If the given array has fixed size, the resulting array will also have fixed size.

set(arr, idx, val)

Sets entry idx of the array to val. If idx is not a nonnegative integer, or if the array has fixed size and idx is larger than the maximum index, the call raises ArgumentError.

size(array)

Gets the number of entries in the array. Entries are numbered from 0 to size(array)-1; hence, this is also the index of the first entry that is guaranteed to not have been previously set.

sparse_foldl(array, acc, fun)

Folds the elements of the array using the given function and initial accumulator value, skipping default-valued entries. The elements are visited in order from the lowest index to the highest.

sparse_foldr(array, acc, fun)

Folds the elements of the array right-to-left using the given function and initial accumulator value, skipping default-valued entries. The elements are visited in order from the highest index to the lowest.

sparse_map(arr, fun)

Maps the given function onto each element of the array, skipping default-valued entries. The elements are visited in order from the lowest index to the highest.

sparse_size(array)

Gets the number of entries in the array up until the last non-default valued entry. In other words, returns idx+1 if idx is the last non-default valued entry in the array, or zero if no such entry exists.

sparse_to_list(array)

Converts the array to a list, skipping default-valued entries.

sparse_to_orddict(array)

Converts the array to an ordered list of pairs {index, value}, skipping default-valued entries.

to_erlang_array(array)

Converts the array to its underlying Erlang's array.

to_list(array)

Converts the array to a list.

to_orddict(array)

Converts the array to an ordered list of pairs {index, value}.

Link to this section Types

element()

Specs

element() :: any()

index()

Specs

index() :: non_neg_integer()

opt()

Specs

opt() ::
  {:fixed, boolean()}
  | :fixed
  | {:default, any()}
  | {:size, non_neg_integer()}
  | non_neg_integer()

opts()

Specs

opts() :: opt() | [opt()]

orddict()

Specs

orddict() :: [{index(), element()}]

t()

Specs

t() :: %Array{content: :array.array()}

Link to this section Functions

default(array)

Specs

default(t()) :: any()

Gets the value used for uninitialized entries.

equal?(array1, array2)

Specs

equal?(t(), t()) :: boolean()

Check if two arrays are equal using ===.

fetch(arr, idx)

Access behavior fetch/2 callback.

fix(arr)

Specs

fix(t()) :: t()

Fixes the size of the array. This prevents it from growing automatically upon insertion.

foldl(array, acc, fun)

Specs

foldl(t(), acc, (index(), element(), acc -> acc)) :: acc when acc: var

Folds the elements of the array using the given function and initial accumulator value. The elements are visited in order from the lowest index to the highest.

If fun is not a function, the call raises ArgumentError.

foldr(array, acc, fun)

Specs

foldr(t(), acc, (index(), element(), acc -> acc)) :: acc when acc: var

Folds the elements of the array right-to-left using the given function and initial accumulator value. The elements are visited in order from the highest index to the lowest.

If fun is not a function, the call raises ArgumentError.

from_erlang_array(erl_arr)

Specs

from_erlang_array(:array.array()) :: t()

Converts an Erlang's array to an array. All properties (size, elements, default value, fixedness) of the original array are preserved.

If erl_arr is not an Erlang's array, the call raises ArgumentError.

from_list(list)

Specs

from_list(list()) :: t()

Equivalent to from_list(list, nil).

from_list(list, default)

Specs

from_list(list(), any()) :: t()

Converts a list to an extendible array. default is used as the value for uninitialized entries of the array.

If list is not a proper list, the call raises ArgumentError.

from_orddict(orddict)

Specs

from_orddict(orddict()) :: t()

Equivalent to from_orddict(orddict, nil).

from_orddict(orddict, default)

Specs

from_orddict(orddict(), any()) :: t()

Converts an ordered list of pairs {index, value} to a corresponding extendible array. default is used as the value for uninitialized entries of the array.

If orddict is not a proper, ordered list of pairs whose first elements are nonnegative integers, the call raises ArgumentError.

get(array, idx)

Specs

get(t(), index()) :: element()

Gets the value of entry idx. If idx is not a nonnegative integer, or if the array has fixed size and idx is larger than the maximum index, the call raises ArgumentError.

get(arr, idx, value)

Access behavior get/3 callback

get_and_update(arr, idx, fun)

Access behavior get_and_update/3 callback

is_array(arr)

Specs

is_array(t()) :: boolean()

is_fix(array)

Specs

is_fix(t()) :: boolean()

Checks if the array has fixed size. Returns true if the array is fixed, otherwise false.

map(arr, fun)

Specs

map(t(), (index(), element() -> any())) :: t()

Maps the given function onto each element of the array. The elements are visited in order from the lowest index to the highest.

If fun is not a function, the call raises ArgumentError.

new()

Specs

new() :: t()

Creates a new, extendible array with initial size zero. The default value is the atom nil, not undefined.

new(options)

Specs

new(opts()) :: t()

Creates a new fixed array according to the given options. By default, the array is extendible and has initial size zero. The default value is the atom nil, if not specified.

options is a single term or a list of terms, selected from the following:

n : non_neg_integer or {:size, n : non_neg_integer}
- Specifies the initial size of the array; this also implies {:fixed, true}. If n is not a nonnegative integer, the call raises ArgumentError.
:fixed or {:fixed, true}
- Creates a fixed-size array.
{:fixed, false}
- Creates an extendible (non fixed-size) array.
{:default, value}
- Sets the default value for the array to value.

pop(arr, idx)

Access behavior pop/2 callback

relax(arr)

Specs

relax(t()) :: t()

Makes the array resizable.

reset(arr, idx)

Specs

reset(t(), index()) :: t()

If idx is not a nonnegative integer, or if the array has fixed size and idx is larger than the maximum index, the call raises ArgumentError.

resize(arr)

Specs

resize(t()) :: t()

Changes the size of the array to that reported by sparse_size/1. If the given array has fixed size, the resulting array will also have fixed size.

resize(arr, size)

Specs

resize(t(), non_neg_integer()) :: t()

Changes the size of the array. If size is not a nonnegative integer, the call raises ArgumentError. If the given array has fixed size, the resulting array will also have fixed size.

set(arr, idx, val)

Specs

set(t(), index(), element()) :: t()

Sets entry idx of the array to val. If idx is not a nonnegative integer, or if the array has fixed size and idx is larger than the maximum index, the call raises ArgumentError.

size(array)

Specs

size(t()) :: non_neg_integer()

Gets the number of entries in the array. Entries are numbered from 0 to size(array)-1; hence, this is also the index of the first entry that is guaranteed to not have been previously set.

sparse_foldl(array, acc, fun)

Specs

sparse_foldl(t(), acc, (index(), element(), acc -> acc)) :: acc when acc: var

Folds the elements of the array using the given function and initial accumulator value, skipping default-valued entries. The elements are visited in order from the lowest index to the highest.

If fun is not a function, the call raises ArgumentError.

sparse_foldr(array, acc, fun)

Specs

sparse_foldr(t(), acc, (index(), element(), acc -> acc)) :: acc when acc: var

If fun is not a function, the call raises ArgumentError.

sparse_map(arr, fun)

Specs

sparse_map(t(), (element() -> any())) :: t()

Maps the given function onto each element of the array, skipping default-valued entries. The elements are visited in order from the lowest index to the highest.

If fun is not a function, the call raises ArgumentError.

sparse_size(array)

Specs

sparse_size(t()) :: non_neg_integer()

sparse_to_list(array)

Specs

sparse_to_list(t()) :: list()

Converts the array to a list, skipping default-valued entries.

sparse_to_orddict(array)

Specs

sparse_to_orddict(t()) :: [{index(), element()}]

Converts the array to an ordered list of pairs {index, value}, skipping default-valued entries.

to_erlang_array(array)

Specs

to_erlang_array(t()) :: :array.array()

Converts the array to its underlying Erlang's array.

to_list(array)

Specs

to_list(t()) :: list()

Converts the array to a list.

to_orddict(array)

Specs

to_orddict(t()) :: [{index(), element()}]

Converts the array to an ordered list of pairs {index, value}.