ClassData

Data Structures
class	ClassData
Functions
	ClassData::ClassData (const mat &, const u32, bool, int)
	ClassData::ClassData (const mat &, const u32)
	ClassData::ClassData (const ClassData &)
	ClassData::~ClassData ()
mat	ClassData::Data () const
u32	ClassData::ClassLabel () const
u32	ClassData::ClassIndex () const
u32	ClassData::Samples () const
u32	ClassData::Attributes () const
ClassData &	ClassData::setData (const mat &)
ClassData &	ClassData::setClassLabel (const u32)
ClassData &	ClassData::setClassIndex (const u32)
	ecocpak::ClassData::ClassData (const mat &, const u32, bool, int)
	ecocpak::ClassData::ClassData (const mat &, const u32)
	ecocpak::ClassData::ClassData (const ClassData &)
	ecocpak::ClassData::~ClassData ()
mat	ecocpak::ClassData::Data () const
u32	ecocpak::ClassData::ClassLabel () const
u32	ecocpak::ClassData::ClassIndex () const
u32	ecocpak::ClassData::Samples () const
u32	ecocpak::ClassData::Attributes () const
ClassData &	ecocpak::ClassData::setData (const mat &)
ClassData &	ecocpak::ClassData::setClassLabel (const u32)
ClassData &	ecocpak::ClassData::setClassIndex (const u32)
Variables
static unsigned int	ClassData::globalIndex = 0
	Static counter to count how many ClassData objects have been created. This counter is increased only if the ClassData object created contains more samples than the number specified in the threshold by user.
static unsigned int	ecocpak::ClassData::globalIndex = 0
	Static counter to count how many ClassData objects have been created. This counter is increased only if the ClassData object created contains more samples than the number specified in the threshold by user.

---

Function Documentation

u32 ClassData::Attributes

(

)

const [inline]

• Member function Attributes returns the atrributes member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • Attributes member variable.

u32 ClassData::Attributes

(

)

const [inline]

• Member function Attributes returns the atrributes member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • Attributes member variable.

ClassData::ClassData	(	const mat &	d,
		const u32	l
	)

• User defined constructor No.2.

• Input Arguments:
  • d : A matrix in which its rows are sample vectors.
  • l : Data class label.

ClassData::ClassData	(	const mat &	d,
		const u32	l,
		bool	sub,
		int	ts
	)

• User defined constructor No.1.

• Input Arguments:
  • d : A 2D matrix where its rows are sample vectors.
  • l : Data class label.
  • sub : Set to true if globalIndex counter is to be increased.
  • ts : Threshold size of class, if the samples of the class to be created aren't greater than or equal to the ts then the globalIndex counter doesn't increase.

ClassData::ClassData

(

const ClassData &

c

)

• Copy constructor.

• Input Arguments:
  • c : A constant reference to ClassData object.

ClassData::ClassData	(	const mat &	d,
		const u32	l,
		bool	sub,
		int	ts
	)

• User defined constructor No.1.

• Input Arguments:
  • d : A 2D matrix where its rows are sample vectors.
  • l : Data class label.
  • sub : Set to true if globalIndex counter is to be increased.
  • ts : Threshold size of class, if the samples of the class to be created aren't greater than or equal to the ts then the globalIndex counter doesn't increase.

ClassData::ClassData	(	const mat &	d,
		const u32	l
	)

• User defined constructor No.2.

• Input Arguments:
  • d : A matrix in which its rows are sample vectors.
  • l : Data class label.

ClassData::ClassData

(

const ClassData &

c

)

• Copy constructor.

• Input Arguments:
  • c : A constant reference to ClassData object.

u32 ClassData::ClassIndex

(

)

const [inline]

• Member function ClassIndex returns the classIndex member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • ClassIndex member variable.

u32 ClassData::ClassIndex

(

)

const [inline]

• Member function ClassIndex returns the classIndex member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • ClassIndex member variable.

u32 ClassData::ClassLabel

(

)

const [inline]

• Member function ClassLabel returns the classLabel member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • ClassLabel member variable.

u32 ClassData::ClassLabel

(

)

const [inline]

• Member function ClassLabel returns the classLabel member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • ClassLabel member variable.

mat ClassData::Data

(

)

const [inline]

• Member function Data returns a 2D matrix where its rows represent the sample vectors in Armadillo format.

• Input Arguments:
  • Void.

• Return Argument:
  • Data member variable.

mat ClassData::Data

(

)

const [inline]

• Member function Data returns a 2D matrix where its rows represent the sample vectors in Armadillo format.

• Input Arguments:
  • Void.

• Return Argument:
  • Data member variable.

u32 ClassData::Samples

(

)

const [inline]

• Member function Samples returns the samples member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • Samples member variable.

u32 ClassData::Samples

(

)

const [inline]

• Member function Samples returns the samples member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • Samples member variable.

ClassData & ClassData::setClassIndex

(

const u32

i

)

[inline]

• Member function setClassIndex sets the classIndex member variable.

• Input Arguments:
  • i : An unsigned integer representing the index of the class.

• Return Argument:
  • A reference to this object.

ClassData & ClassData::setClassIndex

(

const u32

i

)

[inline]

• Member function setClassIndex sets the classIndex member variable.

• Input Arguments:
  • i : An unsigned integer representing the index of the class.

• Return Argument:
  • A reference to this object.

ClassData & ClassData::setClassLabel

(

const u32

l

)

[inline]

• Member function setClassLabel sets the classLabel member variable.

• Input arguments:
  • l : An unsigned integer representing the label of the class.

• Return Argument:
  • A reference to this object.

ClassData & ClassData::setClassLabel

(

const u32

l

)

[inline]

• Member function setClassLabel sets the classLabel member variable.

• Input arguments:
  • l : An unsigned integer representing the label of the class.

• Return Argument:
  • A reference to this object.

ClassData & ClassData::setData

(

const mat &

d

)

[inline]

• Member function setData sets the data member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • A reference to this object.

ClassData & ClassData::setData

(

const mat &

d

)

[inline]

• Member function setData sets the data member variable.

• Input Arguments:
  • Void.

• Return Argument:
  • A reference to this object.

ClassData::~ClassData

(

)

• Destructor.

ClassData::~ClassData

(

)

• Destructor.

---

Variable Documentation

u32 ClassData::globalIndex = 0 [static]

Static counter to count how many ClassData objects have been created. This counter is increased only if the ClassData object created contains more samples than the number specified in the threshold by user.

u32 ClassData::globalIndex = 0 [static]

Static counter to count how many ClassData objects have been created. This counter is increased only if the ClassData object created contains more samples than the number specified in the threshold by user.