Hypex.Register.Map (Hypex v2.1.0)

View Source

A Hypex.Register implementation using a Map.

Maps offer sparse register storage, leading to efficient memory usage. The quick access time leaves them well suited to both read and write use cases, but they don't scale as well as Hypex.Register.Array to higher cardinality.

Recommended for lower cardinality use cases, or when memory is more important.

Summary

Types

t()

Functions

get(register, index, width)

Retrieve a specific bit from a register.

init(width)

Initialize an empty array register of a given width.

merge(left, right)

Merge together two registers of the same width and type.

put(register, index, width, value)

Set a specific bit in a register.

reduce(register, width, acc, fun)

Run a reduction over the inner bits of a register.

Types

t()

@type t() :: map()

Functions

get(register, index, width)

@spec get(t(), index :: number(), width :: number()) :: result :: number()

Retrieve a specific bit from a register.

init(width)

@spec init(width :: number()) :: t()

Initialize an empty array register of a given width.

merge(left, right)

@spec merge(t(), t()) :: t()

Merge together two registers of the same width and type.

put(register, index, width, value)

@spec put(t(), index :: number(), width :: number(), value :: number()) :: t()

Set a specific bit in a register.

reduce(register, width, acc, fun)

@spec reduce(t(), width :: number(), accumulator :: any(), (number(), any() -> any())) ::
  accumulator :: any()

Run a reduction over the inner bits of a register.