doxy/html/array__index__functions_8h_source.html

//

//

/*

    Copyright (C) 2004- 2008, Hammersmith Imanet Ltd

    This file is part of STIR.


    SPDX-License-Identifier: Apache-2.0


    See STIR/LICENSE.txt for details

*/


#ifndef __stir_array_index_functions_h_

#define __stir_array_index_functions_h_


#include "stir/Array.h"

#include "stir/BasicCoordinate.h"


START_NAMESPACE_STIR


/* \ingroup Array

   \name Functions for writing generic code with indexing of multi-dimensional arrays

   */


template <int num_dimensions, int num_dimensions2, typename elemT>

inline const Array<num_dimensions - num_dimensions2, elemT>& get(const Array<num_dimensions, elemT>& a,

                                                                 const BasicCoordinate<num_dimensions2, int>& c);


template <int num_dimensions, typename elemT>

inline const elemT& get(const Array<num_dimensions, elemT>& a, const BasicCoordinate<num_dimensions, int>& c);


template <int num_dimensions, typename T>

inline BasicCoordinate<num_dimensions, int> get_min_indices(const Array<num_dimensions, T>& a);


template <int num_dimensions, typename T, int num_dimensions2>

inline bool next(BasicCoordinate<num_dimensions, int>& indices, const Array<num_dimensions2, T>& a);


END_NAMESPACE_STIR


#include "stir/array_index_functions.inl"


#endif

Array.h
defines the stir::Array class for multi-dimensional (numeric) arrays

BasicCoordinate.h
This file declares class stir::BasicCoordinate and some functions acting on stir::BasicCoordinate obj...

array_index_functions.inl
implementation of functions in stir/array_index_functions.h

stir::get_min_indices
BasicCoordinate< num_dimensions, int > get_min_indices(const Array< num_dimensions, T > &a)
Get the first multi-dimensional index of the array.
Definition array_index_functions.inl:100

stir::get
const Array< num_dimensions - num_dimensions2, elemT > & get(const Array< num_dimensions, elemT > &a, const BasicCoordinate< num_dimensions2, int > &c)
an alternative for array indexing using BasicCoordinate objects
Definition array_index_functions.inl:114

stir::next
bool next(BasicCoordinate< num_dimensions, int > &indices, const Array< num_dimensions2, T > &a)
Given an index into an array, increment it to the next one.
Definition array_index_functions.inl:107