zsig::SignatureT< R, C, T > Class Template Reference

Signature class. More...

#include <signaturet.hh>

List of all members.

Public Types
typedef SignatureT< R, C, T >	signature_type
	This class type.
Public Member Functions
	SignatureT ()
	Default constructor.
	SignatureT (const SignatureT &_sig)
	~SignatureT ()
	Destructor.
void	clear (void)
	Clear this signature values.
signature_type &	operator= (const signature_type &_sig)
	Assign operator.
T *	operator[] (const unsigned &_i)
	Read/write operator.
const T *	operator[] (const unsigned &_i) const
	Read operator.
T **	operator& (void)
	Address operator.
const T **	operator& (void) const
	Address operator.
Friends
std::ostream &	operator<< (std::ostream &out, const signature_type &_s)
	Output stream operator.
std::istream &	operator>> (std::istream &in, signature_type &_s)
	Input stream operator.

---

Detailed Description

template<unsigned R, unsigned C, class T>
class zsig::SignatureT< R, C, T >

Signature class.

Signature of a vertex is a descriptor of the surface surrounding that vertex, in practice it is a scalar field described by a matrix stored in this class.

Template Parameters:

R	Signature row dimension
C	Signature column dimension
T	Signature value type

Examples:

example_mesh.cc, and example_sig.cc.

Definition at line 39 of file signaturet.hh.

---

Member Typedef Documentation

template<unsigned R, unsigned C, class T>

typedef SignatureT< R, C, T > zsig::SignatureT< R, C, T >::signature_type

This class type.

Definition at line 43 of file signaturet.hh.

---

Constructor & Destructor Documentation

template<unsigned R, unsigned C, class T>

zsig::SignatureT< R, C, T >::SignatureT

(

)

[inline]

Default constructor.

Definition at line 46 of file signaturet.hh.

References zsig::SignatureT< R, C, T >::clear().

template<unsigned R, unsigned C, class T>

zsig::SignatureT< R, C, T >::SignatureT

(

const SignatureT< R, C, T > &

_sig

)

[inline]

Copy Constructor

Parameters:

[in]

_sig

Copy this signature

Definition at line 56 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

zsig::SignatureT< R, C, T >::~SignatureT

(

)

[inline]

Destructor.

Definition at line 64 of file signaturet.hh.

---

Member Function Documentation

template<unsigned R, unsigned C, class T>

void zsig::SignatureT< R, C, T >::clear

(

void

)

[inline]

Clear this signature values.

Definition at line 71 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

signature_type& zsig::SignatureT< R, C, T >::operator=

(

const signature_type &

_sig

)

[inline]

Assign operator.

Parameters:

[in]

_sig

Copy signature

Returns:

This signature as a clone of the copy signature

Definition at line 81 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

T* zsig::SignatureT< R, C, T >::operator[]

(

const unsigned &

_i

)

[inline]

Read/write operator.

Parameters:

[in]

_i

Index of row

Returns:

Row at index

Definition at line 93 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

const T* zsig::SignatureT< R, C, T >::operator[]

(

const unsigned &

_i

)

const [inline]

Read operator.

Parameters:

[in]

_i

Index of row

Returns:

Constant row at index

Definition at line 100 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

T** zsig::SignatureT< R, C, T >::operator&

(

void

)

[inline]

Address operator.

Returns:

Address value of this signature

Definition at line 137 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

const T** zsig::SignatureT< R, C, T >::operator&

(

void

)

const [inline]

Address operator.

Returns:

Constant address value of this signature

Definition at line 143 of file signaturet.hh.

---

Friends And Related Function Documentation

template<unsigned R, unsigned C, class T>

std::ostream& operator<<	(	std::ostream &	out,
		const signature_type &	_s
	)		[friend]

Output stream operator.

Parameters:

[in,out]	out	Output stream
[in]	_s	Signature to output values from

Returns:

Output stream

Definition at line 108 of file signaturet.hh.

template<unsigned R, unsigned C, class T>

std::istream& operator>>	(	std::istream &	in,
		signature_type &	_s
	)		[friend]

Input stream operator.

Parameters:

[in,out]	in	Input stream
[in]	_s	Signature to input values to

Returns:

Input stream

Definition at line 125 of file signaturet.hh.

---

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

• include/signaturet.hh