ODIN: RecoDim< Ndim, d1, d2, d3, d4, d5, d6 > Struct Template Reference

ODIN

#include <index.h>

Static Public Member Functions
static unsigned int	dim ()

static RecoCoord	preset_coord (RecoIndex::indexMode m)

static void	modify (RecoIndex::indexMode m, RecoCoord &coord)

static void	create_index (const RecoCoord &coord, TinyVector< int, Ndim > &index)

static void	create_shape (const RecoCoord &coord, TinyVector< int, Ndim > &shape)

static void	set_index (const TinyVector< int, Ndim > &index, RecoCoord &coord)

Detailed Description

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>
struct RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >

Helper template to define a set of 'Ndim' dimensions using default arguments for unused dimensions.

Definition at line 372 of file index.h.

Member Function Documentation

◆ create_index()

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>

static void RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >::create_index	(	const RecoCoord &	coord,
		TinyVector< int, Ndim > &	index
	)

inlinestatic

Creates 'Ndim' dimensional index vector in specified dimensions using coordinate 'coord'.

Definition at line 392 of file index.h.

◆ create_shape()

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>

static void RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >::create_shape	(	const RecoCoord &	coord,
		TinyVector< int, Ndim > &	shape
	)

inlinestatic

Creates 'Ndim' dimensional shape vector in specified dimensions using coordinate 'coord'.

Definition at line 405 of file index.h.

◆ dim()

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>

static unsigned int RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >::dim ( )

inlinestatic

Returns the number of dimensions to set/modify.

Definition at line 377 of file index.h.

◆ modify()

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>

static void RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >::modify	(	RecoIndex::indexMode	m,
		RecoCoord &	coord
	)

inlinestatic

Sets specified dimensions in coordinate 'coord' to mode 'm'.

Definition at line 387 of file index.h.

◆ preset_coord()

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>

static RecoCoord RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >::preset_coord ( RecoIndex::indexMode m )

inlinestatic

Returns coordinate with specified dimensions set to mode 'm'.

Definition at line 382 of file index.h.

◆ set_index()

template<unsigned int Ndim, recoDim d1 = n_recoDims, recoDim d2 = n_recoDims, recoDim d3 = n_recoDims, recoDim d4 = n_recoDims, recoDim d5 = n_recoDims, recoDim d6 = n_recoDims>

static void RecoDim< Ndim, d1, d2, d3, d4, d5, d6 >::set_index	(	const TinyVector< int, Ndim > &	index,
		RecoCoord &	coord
	)

inlinestatic

Copies values of 'Ndim' dimensional index vector to specified dimensions in 'coord'.

Definition at line 419 of file index.h.

The documentation for this struct was generated from the following file:

index.h