helib::HyperCube< T > Class Template Reference

A multi-dimensional cube. More...

#include <hypercube.h>

Public Member Functions
	HyperCube (const HyperCube &other)=default
	HyperCube (const CubeSignature &_sig)
	initialize a HyperCube with a CubeSignature More...
HyperCube &	operator= (const HyperCube< T > &other)
	assignment: signatures must be the same More...
bool	operator== (const HyperCube< T > &other) const
	equality testing: signatures must be the same More...
bool	operator!= (const HyperCube< T > &other) const
const CubeSignature &	getSig () const
	const ref to signature More...
NTL::Vec< T > &	getData ()
const NTL::Vec< T > &	getData () const
	read-only ref to data vector More...
long	getSize () const
	total size of cube More...
long	getNumDims () const
	number of dimensions More...
long	getDim (long d) const
	size of dimension d More...
long	getProd (long d) const
	product of sizes of dimensions d, d+1, ... More...
long	getProd (long from, long to) const
	product of sizes of dimensions from, from+1, ..., to-1 More...
long	getCoord (long i, long d) const
	get coordinate in dimension d of index i More...
long	addCoord (long i, long d, long offset) const
	add offset to coordinate in dimension d of index i More...
long	numSlices (long d=1) const
	number of slices More...
long	sliceSize (long d=1) const
	size of one slice More...
long	numCols () const
	number of columns More...
T &	at (long i)
	reference to element at position i, with bounds check More...
T &	operator[] (long i)
	reference to element at position i, without bounds check More...
const T &	at (long i) const
	read-only reference to element at position i, with bounds check More...
const T &	operator[] (long i) const
	read-only reference to element at position i, without bounds check More...
void	rotate1D (long i, long k)
	rotate k positions along the i'th dimension More...
void	shift1D (long i, long k)
	Shift k positions along the i'th dimension with zero fill. More...

Detailed Description

template<typename T>
class helib::HyperCube< T >

A multi-dimensional cube.

Such an object is initialized with a CubeSignature: a reference to the signature is stored with the cube, and so the signature must remain alive during the lifetime of the cube, to prevent dangling pointers.

Constructor & Destructor Documentation

HyperCube() [1/2]

template<typename T >

helib::HyperCube< T >::HyperCube ( const HyperCube< T > &  other )

default

HyperCube() [2/2]

template<typename T >

helib::HyperCube< T >::HyperCube ( const CubeSignature &  _sig )

inline

initialize a HyperCube with a CubeSignature

Member Function Documentation

addCoord()

template<typename T >

long helib::HyperCube< T >::addCoord ( long  i, long  d, long  offset  ) const

inline

add offset to coordinate in dimension d of index i

at() [1/2]

template<typename T >

T& helib::HyperCube< T >::at ( long  i )

inline

reference to element at position i, with bounds check

at() [2/2]

template<typename T >

const T& helib::HyperCube< T >::at ( long  i ) const

inline

read-only reference to element at position i, with bounds check

getCoord()

template<typename T >

long helib::HyperCube< T >::getCoord ( long  i, long  d  ) const

inline

get coordinate in dimension d of index i

getData() [1/2]

template<typename T >

NTL::Vec<T>& helib::HyperCube< T >::getData ( )

inline

read/write ref to the data vector. Note that the length of data is fixed upon construction, so it cannot be changed through this ref.

getData() [2/2]

template<typename T >

const NTL::Vec<T>& helib::HyperCube< T >::getData ( ) const

inline

read-only ref to data vector

getDim()

template<typename T >

long helib::HyperCube< T >::getDim ( long  d ) const

inline

size of dimension d

getNumDims()

template<typename T >

long helib::HyperCube< T >::getNumDims ( ) const

inline

number of dimensions

getProd() [1/2]

template<typename T >

long helib::HyperCube< T >::getProd ( long  d ) const

inline

product of sizes of dimensions d, d+1, ...

getProd() [2/2]

template<typename T >

long helib::HyperCube< T >::getProd ( long  from, long  to  ) const

inline

product of sizes of dimensions from, from+1, ..., to-1

getSig()

template<typename T >

const CubeSignature& helib::HyperCube< T >::getSig ( ) const

inline

const ref to signature

getSize()

template<typename T >

long helib::HyperCube< T >::getSize ( ) const

inline

total size of cube

numCols()

template<typename T >

long helib::HyperCube< T >::numCols ( ) const

inline

number of columns

numSlices()

template<typename T >

long helib::HyperCube< T >::numSlices ( long  d = 1 ) const

inline

number of slices

operator!=()

template<typename T >

bool helib::HyperCube< T >::operator!= ( const HyperCube< T > &  other ) const

inline

operator=()

template<typename T >

HyperCube& helib::HyperCube< T >::operator= ( const HyperCube< T > &  other )

inline

assignment: signatures must be the same

operator==()

template<typename T >

bool helib::HyperCube< T >::operator== ( const HyperCube< T > &  other ) const

inline

equality testing: signatures must be the same

operator[]() [1/2]

template<typename T >

T& helib::HyperCube< T >::operator[] ( long  i )

inline

reference to element at position i, without bounds check

operator[]() [2/2]

template<typename T >

const T& helib::HyperCube< T >::operator[] ( long  i ) const

inline

read-only reference to element at position i, without bounds check

rotate1D()

template<typename T >

void helib::HyperCube< T >::rotate1D	(	long	i,
		long	k
	)

rotate k positions along the i'th dimension

shift1D()

template<typename T >

void helib::HyperCube< T >::shift1D	(	long	i,
		long	k
	)

Shift k positions along the i'th dimension with zero fill.

sliceSize()

template<typename T >

long helib::HyperCube< T >::sliceSize ( long  d = 1 ) const

inline

size of one slice