Skip to content

iris::build::BaseType< V > Class Template Reference

Doxygen 1.15.0 generates this reference during each site build from the public headers. The C++ guide shows the API in use.

A base type: one of the constants int_, float_, num, word and rest. More...

#include <iris/build.hpp>

Public Member Functions

constexpr BaseType (detail::HostName, std::string_view keyword)
 The base type with the keyword keyword; see the constants.
constexpr std::string_view keyword () const
 Return the keyword.
template<Operand E>
TypeOf< V, 1 > dim (E &&extent) const
 This type with a dimension of size elements.
template<std::ranges::input_range R>
requires Operand<std::ranges::range_reference_t<R>>
TypeOf< V, dynamic_depth > dims (R &&sizes) const
 This type with a dimension for each size in sizes.
template<Operand E>
TypeOf< V, 0 > layout (E &&value) const
 This type read with the layout layout.
template<Operand E>
TypeOf< V, 0 > offset (E &&value) const
 This type with offset added to every value read.
template<class E>
requires std::same_as<std::remove_cvref_t<E>, Eol> || Operand<E>
ListReading< V > until (E &&end) const
 A list of this type that end ends: eol, or a sentinel value.

Detailed Description

template<class V>
class iris::build::BaseType< V >

A base type: one of the constants int_, float_, num, word and rest.

Its methods give a TypeOf with dimensions or options, or a ListReading.

Constructor & Destructor Documentation

BaseType()

template<class V>
iris::build::BaseType< V >::BaseType ( detail::HostName ,
std::string_view keyword )
inlineconstexpr

The base type with the keyword keyword; see the constants.

Member Function Documentation

dim()

template<class V>
template<Operand E>
TypeOf< V, 1 > iris::build::BaseType< V >::dim ( E && extent) const
inlinenodiscard

This type with a dimension of size elements.

dims()

template<class V>
template<std::ranges::input_range R>
requires Operand<std::ranges::range_reference_t<R>>
TypeOf< V, dynamic_depth > iris::build::BaseType< V >::dims ( R && sizes) const
inlinenodiscard

This type with a dimension for each size in sizes.

keyword()

template<class V>
std::string_view iris::build::BaseType< V >::keyword ( ) const
inlinenodiscardconstexpr

Return the keyword.

layout()

template<class V>
template<Operand E>
TypeOf< V, 0 > iris::build::BaseType< V >::layout ( E && value) const
inlinenodiscard

This type read with the layout layout.

offset()

template<class V>
template<Operand E>
TypeOf< V, 0 > iris::build::BaseType< V >::offset ( E && value) const
inlinenodiscard

This type with offset added to every value read.

until()

template<class V>
template<class E>
requires std::same_as<std::remove_cvref_t<E>, Eol> || Operand<E>
ListReading< V > iris::build::BaseType< V >::until ( E && end) const
inlinenodiscard

A list of this type that end ends: eol, or a sentinel value.