Multi-dimensional binning spec of a compile-time dimension. More...

Inheritance diagram for Acts::MultiAxisSpecXD< DIM >:

Collaboration diagram for Acts::MultiAxisSpecXD< DIM >:

Public Types
using	Options = std::array<AxisSpec::Options, DIM>
	Consumer supplied inputs, one `AxisSpec::Options` per axis, in axis order; an all-default set leaves every property to the spec.
Public Types inherited from Acts::MultiAxisSpec
using	Options = std::vector<AxisSpec::Options>
	Consumer supplied inputs, one `AxisSpec::Options` per axis, in axis order.

Public Member Functions
	MultiAxisSpecXD (std::array< AxisSpec, DIM > axisSpecs)
	Construct from one axis spec per dimension.
std::unique_ptr< IMultiAxisXD< DIM > >	buildMultiAxis (const Options &options={}) const
	Build a multi-axis, one option set per axis.
Public Member Functions inherited from Acts::MultiAxisSpec
	MultiAxisSpec (const MultiAxisSpec &other)=default
	Copy constructor.
	MultiAxisSpec (MultiAxisSpec &&other) noexcept=default
	Move constructor.
	MultiAxisSpec (std::vector< AxisSpec > axisSpecs)
	Construct from one axis spec per dimension.
const AxisSpec &	axisSpec (std::size_t i) const
	Get the axis spec at the given dimension.
std::span< const AxisSpec >	axisSpecs () const
	Get all axis specs.
std::unique_ptr< IMultiAxis >	buildMultiAxis (const Options &options={}) const
	Build a multi-axis, one option set per axis or none at all.
bool	isDeferred () const
	Check if any of the contained specs is deferred, i.e.
MultiAxisSpec &	operator= (const MultiAxisSpec &other)=default
	Copy assignment.
MultiAxisSpec &	operator= (MultiAxisSpec &&other) noexcept=default
	Move assignment.
std::size_t	size () const
	Get the number of axes spanning the grid.
std::string	toString () const
	Get a string representation of this spec.

Additional Inherited Members
Protected Member Functions inherited from Acts::MultiAxisSpec
std::unique_ptr< IMultiAxis >	buildMultiAxisImpl (std::span< const AxisSpec::Options > options) const
	Build a multi-axis from a view onto the option sets.

Detailed Description

template<std::size_t DIM>
class Acts::MultiAxisSpecXD< DIM >

Multi-dimensional binning spec of a compile-time dimension.

Adds a statically sized construction and build API on top of MultiAxisSpec , mirroring IMultiAxis and IMultiAxisXD .

Template Parameters

DIM	number of axes (dimension of the grid)

Constructor & Destructor Documentation

template<std::size_t DIM>

Acts::MultiAxisSpecXD< DIM >::MultiAxisSpecXD ( std::array< AxisSpec, DIM > axisSpecs )

explicit

Construct from one axis spec per dimension.

Parameters

axisSpecs the axis specs, in axis order

template<std::size_t DIM>

std::unique_ptr< IMultiAxisXD< DIM > > Acts::MultiAxisSpecXD< DIM >::buildMultiAxis ( const Options & options = {} ) const

Build a multi-axis, one option set per axis.

Parameters

options one option set per axis, in axis order

Exceptions

std::domain_error	if a property is given by neither side
std::invalid_argument	if a property mismatches