Package 'xlamisc'

Description

Helper functions for the XLA ecosystem.

Author(s)

Maintainer: Sebastian Fischer [email protected] (ORCID)

Authors:

• Daniel Falbel [email protected] (ORCID)

Description

Operates on a named list of bibentry() entries and formats them for documentation with roxygen2.

• format_bib() is intended to be called in the ⁠@references⁠ section and formats the complete entry using tools::toRd().

• cite_bib() returns a short inline citation in the format "LastName (Year)".

Usage

format_bib(..., bibentries = NULL)

cite_bib(..., bibentries = NULL)

Arguments

Value

(character(1)).

Examples

bibentries = list(R = citation())
format_bib("R")
cite_bib("R")

Description

Get the "dimension" of an R array or vector.

Usage

get_dims(data)

Arguments

Value

(integer())

Description

An implementation of a least-recently-used cache built on top of utils::hashtab. Therefore, arbitrary keys can be used, as opposed to the implementation in cachemem, which relies on environments.

Details

This LRU cache is implemented as a combination of a hashmap and a doubly linked list. The hashmap is used for lookups and the doubly linked list is used to maintain the ordering of most recently used to least recently used items. Whenever an element is added or accessed, it is moved to the front of the list.

Active bindings

Methods

Public methods

• LRUCache$new()

• LRUCache$get()

• LRUCache$set()

• LRUCache$has()

• LRUCache$remove()

• LRUCache$clear()

• LRUCache$keys_mru_to_lru()

• LRUCache$clone()

Method new()

Initialize a new LRU cache with a given capacity.

Usage

LRUCache$new(capacity)

Arguments

Method get()

Get the value for key and mark it as most-recently-used.

Usage

LRUCache$get(key, default = NULL)

Arguments

Method set()

Set the value for key, updating recency and evicting LRU as needed.

Usage

LRUCache$set(key, value)

Arguments

Method has()

Check whether a given key exists in the cache.

Usage

LRUCache$has(key)

Arguments

Method remove()

Remove key from the cache, returning the value if it was present or NULL otherwise.

Usage

LRUCache$remove(key)

Arguments

Method clear()

Clear all entries from the cache.

Usage

LRUCache$clear()

Method keys_mru_to_lru()

Return keys ordered from most-recently-used to least-recently-used.

Usage

LRUCache$keys_mru_to_lru()

Method clone()

The objects of this class are cloneable with this method.

Usage

LRUCache$clone(deep = FALSE)

Arguments

Description

Returns a constructor for a typed list. The constructor checks that items is a list and runs the optional validator, but does not iterate items to validate per-element class – this makes it cheap enough to call from hot paths like IR construction. Trust the caller to pass items of the right class; downstream consumers will fail with their own (clearer) error if not.

Usage

new_list_of(class_name, item_class, validator = NULL)

Arguments

Value

A list-of-class_name constructor.

Description

Like seq_len and seq_along but starts at 0.

Usage

seq_len0(n)

seq_along0(x)

Arguments

Value

(integer())

Description

Formats a shape vector as a string like ⁠(2,3,4)⁠. NA values are replaced with ⁠?⁠.

Usage

shapevec_repr(shape)

Arguments

Value

(character(1))
The formatted shape string.

Description

Applies shapevec_repr() to multiple shapes and combines them.

Usage

shapevec_reprs(...)

Arguments

Value

(character(1))
The formatted shapes, separated by ", ".

Description

Remove elements from a vector by index. Also works for empty indices.

Usage

without(x, indices)

Arguments

Value

(vector)
The vector with the elements removed.