Global namespace

Namespaces

Name

Description

boost

Main namespace for the library

boost namespace

Main namespace for the library

Namespaces

Name

Description

multi

Main namespace for the library

boost::multi namespace

Main namespace for the library

Namespaces

Name

Description

elementwise

Namespace for elementwise operators (+, ‐, *, and other convenience functions)

pmr

Convenience aliases using std::pmr::polymorphic_allocator as the allocator.

Types

Name

Description

array

A multidimensional array value

array_ref

A D‐dimensional view of a contiguous, pre‐existing memory buffer.

array_types

bind_category

bind_front_t

bind_transposed_t

const_subarray

Read‐only D‐dimensional subarray‐reference (view into a subarray)

cursor_t

dynamic_array

A D‐dimensional array whose size is bound at construction and never changes.

elements_iterator_t

elements_range_t

initializer_array

invoke_result_from_tuple

move_subarray

restriction

restriction_elements_iterator

restriction_elements_t

restriction_iterator

subarray

Mutable D‐dimensional view into part or all of an array

subarray_ptr

unique_array

Type Aliases

Name

Description

array_const_view

array_cref

array_iterator [deprecated]

array_mref

array_ptr [deprecated]

array_view

const_subarray_ptr

inplace_array

Stack‐allocated multidimensional array whose maximum size is encoded in the element type T

restriction_idl

static_array [deprecated]

Functions

Name

Description

apply_

base

begin

cbegin

cend

data_elements

decay

diagonal

dimensionality

end

extension [deprecated]

extent

get_allocator

lexicographical_compare

make_array_ref

move

operator+

Addition operators

operator‐

Subtraction operators

operator‐>*

operator/

operatorˆ

operator~

Bitwise negation operators

origin

ref

restricted

rotated

size

sizes

static_array_cast

stride

swap

transposed

uninitialized_copy

unrotated

operator<<

Stream insertion operators

operator==

Equality operators

operator!=

Inequality operators

operator<

Less‐than operators

operator<=

Less‐than‐or‐equal operators

operator>

Greater‐than operators

operator>=

Greater‐than‐or‐equal operators

Variables

Name

Description

force_element_trivial

When specialized to true for an element type, the library treats that type as if it were trivially default‐constructible and trivially destructible. This is a performance opt‐in for types that are technically non‐trivial under the language rules (such as std::complex).

force_element_trivial_default_construction

When specialized to true, skip the per‐element default‐construction loop on array allocation.

force_element_trivial_destruction

When specialized to true, skip the per‐element destructor loop on array teardown.

serialization_array_version

boost::multi::elementwise namespace

Namespace for elementwise operators (+, ‐, *, and other convenience functions)

Functions

Name

Description

abs

creates a array with the function abs applied lazily elementwise.

apply

apply_front

exp

creates a array with the function exp applied lazily elementwise.

eye

log

creates a array with the function log applied lazily elementwise.

map

operator&&

operator*

creates a array with the * operation applied lazily elementwise to two arrays

operator+

creates a array with the + operation applied lazily elementwise to two arrays

operator‐

creates a array with the operation applied lazily elementwise to two arrays

operator/

creates a array with the / operation applied lazily elementwise to two arrays

operator|

Bitwise disjunction operators

operator||

zeros

boost::multi::pmr namespace

Convenience aliases using std::pmr::polymorphic_allocator as the allocator.

Type Aliases

Name

Description

array

Alias for multi::array using std::pmr::polymorphic_allocator, so storage comes from a std::pmr::memory_resource.

dynamic_array

Alias for multi::dynamic_array using std::pmr::polymorphic_allocator, so storage comes from a std::pmr::memory_resource.

Created with MrDocs