xcoordinate_view

Defined in xframe/xcoordinate_view.hpp

template<class K, class L = xtl::mpl::vector<int, std::size_t, char, xf::fstring>, class S = std::size_t, class MT = hash_map_tag>
class xcoordinate_view : public xf::xcoordinate_base<K, xaxis_view<L, S, MT>>

view of an xcoordinate

The xcoordinate_view is used for modeling a view on an existing xcoordinate, i.e. a subset of this xcoordinate. This is done by either ignoring some axes, or by holding views on axes of the underlying xcoordinate.

See

xaxis_view

Template Parameters

  • K: the type of dimension names.

  • L: the type list of axes labels.

  • S: the integer type used to represent positions in axes. Default value is std::size_t.

  • MT: the tag used for choosing the map type which holds the label- position pairs in the axes. Possible values are map_tag and hash_map_tag. Default value is hash_map_tag.

Public Functions

xcoordinate_view(const map_type &axes)

Constructs an xcoordinate_view with the given mapping of dumension names to views on axes.

The mapping is copied.

Parameters

  • axes: the dimension names to views on axes mapping.

xcoordinate_view(map_type &&axes)

Constructs an xcoordinate_view with the given mapping of dumension names to views on axes.

This mapping is moved and therefore it is invalid after the xcoordinate_view has been constructed.

Parameters

  • axes: the dimension names to views on axes mapping.

template<class K, class L, class S, class MT>
xcoordinate_view<K, L, S, MT> xf::coordinate_view(const std::map<K, xaxis_view<L, S, MT>> &axes)

Builds and returns an xcoordinate_view from the specified mapping of dimension names to views on axes.

The map is copied.

Parameters

  • axes: the dimension names to views on axes mapping.

template<class K, class L, class S, class MT>
xcoordinate_view<K, L, S, MT> xf::coordinate_view(std::map<K, xaxis_view<L, S, MT>> &&axes)

Builds and returns an xcoordinate_viewfrom the specified mapping of dimension names to views on axes.

The map is moved, therefore it is invalid after the xcoordinate object has been built.

Parameters

  • axes: the dimension names to views on axes mapping.