pss::astrotypes::DimensionSpan< Dimension > Class Template Reference

Defines a contiguous range over dimension in index. More...

#include <src/cpp/pss/astrotypes/multiarray/DimensionSpan.h>

Public Member Functions
	DimensionSpan (DimensionIndex< Dimension > start_index, DimensionIndex< Dimension > end_index)
	DimensionSpan (DimensionIndex< Dimension > start_index, DimensionSize< Dimension > size)
	DimensionSpan (DimensionSize< Dimension > size)
	convenience operator, start_index will be set to 0 More...
DimensionIndex< Dimension > &	start ()
DimensionIndex< Dimension > const &	start () const
void	start (DimensionIndex< Dimension > s)
DimensionSize< Dimension > &	span ()
DimensionSize< Dimension > const &	span () const
void	span (DimensionSize< Dimension > s)
DimensionSpan< Dimension > &	trim (DimensionSize< Dimension > bounds)
	ensure the span fits within the size provided More...

Detailed Description

template<typename Dimension>
class pss::astrotypes::DimensionSpan< Dimension >

Defines a contiguous range over dimension in index.

Definition at line 41 of file DimensionSpan.h.

Constructor & Destructor Documentation

template<typename Dimension >

pss::astrotypes::DimensionSpan< Dimension >::DimensionSpan	(	DimensionIndex< Dimension >	start_index,
		DimensionIndex< Dimension >	end_index
	)

Definition at line 29 of file DimensionSpan.cpp.

template<typename Dimension >

pss::astrotypes::DimensionSpan< Dimension >::DimensionSpan	(	DimensionIndex< Dimension >	start_index,
		DimensionSize< Dimension >	size
	)

Definition at line 36 of file DimensionSpan.cpp.

template<typename Dimension >

pss::astrotypes::DimensionSpan< Dimension >::DimensionSpan

(

DimensionSize< Dimension >

size

)

convenience operator, start_index will be set to 0

Definition at line 43 of file DimensionSpan.cpp.

Member Function Documentation

template<typename Dimension>

DimensionSize<Dimension>& pss::astrotypes::DimensionSpan< Dimension >::span ( )

inline

Definition at line 52 of file DimensionSpan.h.

template<typename Dimension>

DimensionSize<Dimension> const& pss::astrotypes::DimensionSpan< Dimension >::span ( ) const

inline

Definition at line 53 of file DimensionSpan.h.

template<typename Dimension>

void pss::astrotypes::DimensionSpan< Dimension >::span ( DimensionSize< Dimension >  s )

inline

Definition at line 54 of file DimensionSpan.h.

template<typename Dimension>

DimensionIndex<Dimension>& pss::astrotypes::DimensionSpan< Dimension >::start ( )

inline

Definition at line 49 of file DimensionSpan.h.

template<typename Dimension>

DimensionIndex<Dimension> const& pss::astrotypes::DimensionSpan< Dimension >::start ( ) const

inline

Definition at line 50 of file DimensionSpan.h.

template<typename Dimension>

void pss::astrotypes::DimensionSpan< Dimension >::start ( DimensionIndex< Dimension >  s )

inline

Definition at line 51 of file DimensionSpan.h.

template<typename Dimension >

DimensionSpan< Dimension > & pss::astrotypes::DimensionSpan< Dimension >::trim ( DimensionSize< Dimension >  bounds )

inline

ensure the span fits within the size provided

Definition at line 50 of file DimensionSpan.cpp.