mrdocs::dom::Array

An array of values

Synopsis

Declared in <mrdocs/Dom/Array.hpp>

class Array final

Types

Name

Description

iterator

A constant iterator referencing an element in an Array.

const_iterator

A constant iterator referencing an element in an Array.

const_pointer

A pointer to an element.

const_reference

A reference to an element.

difference_type

A signed integral type.

impl_type

The implementation type.

pointer

A pointer to an element.

reference

A reference to an element.

size_type

An unsigned integral type used for indexes and sizes.

storage_type

The type of storage used by the default implementation.

value_type

The type of an element.

Member Functions

Name

Description

Array [constructor]

Constructor.

~Array [destructor]

Destructor.

operator=

Assignment.

at

Return the i‐th element.

back

Return the last element.

begin

Return an iterator to the beginning of the range of elements.

emplace_back

Append an element to the end of the array.

empty

Return true if the array is empty.

end

Return an iterator to the end of the range of elements.

front

Return the first element.

get

Return the i‐th element, without bounds checking.

impl

Return the implementation used by this object.

push_back

Append an element to the end of the array.

set

Set the i‐th element, without bounds checking.

size

Return the number of elements in the array.

swap

Swap two arrays.

type_key

Return the type key of the implementation.

Friends

Name

Description

mrdocs::dom::newArray

Return a new array using a custom implementation.

mrdocs::dom::toString

Return a diagnostic string.

mrdocs::dom::operator<=>

Compare two arrays for precedence.

mrdocs::dom::operator==

Compare two arrays for equality.

mrdocs::dom::swap

Swap two arrays.

mrdocs::dom::operator+

mrdocs::dom::operator+

mrdocs::dom::operator+

Concatenate two arrays.

Non-Member Functions

Name

Description

LazyArray

Return a new dom::Array based on a FromValue context

LazyArray

Return a new dom::Array based on a lazy array implementation.

TransformArray

Return a new dom::Array based on a transformed lazy array implementation.

::mrdocs::getParents

Return a list of the parent symbols of the specified Info.

::mrdocs::helpers::and_fn

"and" helper function

::mrdocs::helpers::eq_fn

"eq" helper function

::mrdocs::helpers::ne_fn

"ne" helper function

::mrdocs::helpers::not_fn

"not" helper function

::mrdocs::helpers::or_fn

"or" helper function

Description

Arrays are a collection of indexed values. They are an extension of objects with a particular relationship between integer‐keyed properties and some abstract length‐property. Besides, they include convenient methods to manipulate these ordered sequences of values.

Created with MrDocs