Public Member Functions
rtc::Array3< T > Class Template Reference

#include <rtcArray3.h>

Inheritance diagram for rtc::Array3< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Array3 ()
 Array3 (int n1, int n2, int n3)
 Array3 (const Array< T, 3 > &a)
int indexOf (int i1, int i2, int i3) const
T & operator() (int i1, int i2, int i3)
operator() (int i1, int i2, int i3) const
void setSize (int n1, int n2, int n3)

Detailed Description

template<class T>
class rtc::Array3< T >

A 3-Dimensional Array

Definition at line 39 of file rtcArray3.h.


Constructor & Destructor Documentation

template<class T >
rtc::Array3< T >::Array3 ( ) [inline]

Ctor that does no initalization.

Definition at line 85 of file rtcArray3.h.

template<class T >
rtc::Array3< T >::Array3 ( int  n1,
int  n2,
int  n3 
) [inline]

Ctor that starts with given dimensions

Parameters:
n1,n2,n3is the dimensions

Definition at line 91 of file rtcArray3.h.

template<class T >
rtc::Array3< T >::Array3 ( const Array< T, 3 > &  a) [inline]

Ctor that initializes an Array3<T> with a Array<T,3>.

Definition at line 98 of file rtcArray3.h.


Member Function Documentation

template<class T >
int rtc::Array3< T >::indexOf ( int  i1,
int  i2,
int  i3 
) const [inline]

Returns linear index of given array indices

Parameters:
i1,i2,i3are the indices
Returns:
the linear index in the data array x

Definition at line 138 of file rtcArray3.h.

template<class T >
T & rtc::Array3< T >::operator() ( int  i1,
int  i2,
int  i3 
) [inline]

Returns mutable reference to array element

Parameters:
i1,i2,i3are the indices
Returns:
a reference to the array element

Definition at line 116 of file rtcArray3.h.

template<class T >
T rtc::Array3< T >::operator() ( int  i1,
int  i2,
int  i3 
) const [inline]

Returns inmutable reference to array element

Parameters:
i1,i2,i3are the indices
Returns:
the value of the array element

Definition at line 127 of file rtcArray3.h.

template<class T >
void rtc::Array3< T >::setSize ( int  n1,
int  n2,
int  n3 
) [inline]

Set the size of the array

Parameters:
n1,n2,n3are the sizes of the array in each dimension

Definition at line 107 of file rtcArray3.h.


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


rtc
Author(s): Benjamin Pitzer
autogenerated on Thu Jan 2 2014 11:04:54