helib::ConstCubeSlice< T > Class Template Reference

A constant lower-dimension slice of a hypercube. More...

#include <hypercube.h>

Inheritance diagram for helib::ConstCubeSlice< T >:

Public Member Functions
	ConstCubeSlice (const HyperCube< T > &_cube)
	initialize the slice to the full cube More...
	ConstCubeSlice (const NTL::Vec< T > &_data, const CubeSignature &_sig)
	ConstCubeSlice (const ConstCubeSlice &bigger, long i, long _dimOffset=1)
	ConstCubeSlice (const HyperCube< T > &_cube, long i, long _dimOffset=1)
const CubeSignature &	getSig () const
	const ref to signature More...
long	getSize () const
	total size 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...
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...

Detailed Description

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

A constant lower-dimension slice of a hypercube.

A ConstCubeSlice acts like a pointer to a lower dimensional constant subcube of a hypercube. It is initialized using a reference to a hypercube, which must remain alive during the lifetime of the slice, to prevent dangling pointers. The subclass CubeSlice works also with non-constant cubes and subcubes.

In addition, for greater flexibility, a "slice" may be initialized with a vector and a signature, rather than a cube

Constructor & Destructor Documentation

ConstCubeSlice() [1/4]

template<typename T >

helib::ConstCubeSlice< T >::ConstCubeSlice ( const HyperCube< T > &  _cube )

inlineexplicit

initialize the slice to the full cube

ConstCubeSlice() [2/4]

template<typename T >

helib::ConstCubeSlice< T >::ConstCubeSlice ( const NTL::Vec< T > &  _data, const CubeSignature &  _sig  )

inline

ConstCubeSlice() [3/4]

template<typename T >

helib::ConstCubeSlice< T >::ConstCubeSlice	(	const ConstCubeSlice< T > &	bigger,
		long	i,
		long	_dimOffset = 1
	)

initialize the slice to point to the i-th subcube (with some given dimension offset) of the cube pointed to by _cube or bigger.

ConstCubeSlice() [4/4]

template<typename T >

helib::ConstCubeSlice< T >::ConstCubeSlice	(	const HyperCube< T > &	_cube,
		long	i,
		long	_dimOffset = 1
	)

Member Function Documentation

addCoord()

template<typename T >

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

inline

add offset to coordinate in dimension d of index i

at()

template<typename T >

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

inline

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

getCoord()

template<typename T >

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

inline

get coordinate in dimension d of index i

getDim()

template<typename T >

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

inline

size of dimension d

getNumDims()

template<typename T >

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

inline

number of dimensions

getProd() [1/2]

template<typename T >

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

inline

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

getProd() [2/2]

template<typename T >

long helib::ConstCubeSlice< 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::ConstCubeSlice< T >::getSig ( ) const

inline

const ref to signature

getSize()

template<typename T >

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

inline

total size

numCols()

template<typename T >

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

inline

number of columns

numSlices()

template<typename T >

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

inline

number of slices

operator[]()

template<typename T >

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

inline

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

sliceSize()

template<typename T >

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

inline

size of one slice