KmeansParameters Class Reference

KmeansParameters is a simple record class for easier passing of Kmeans parameters. More...

Inherits java::io::Serializable, and java::io::Serializable.

List of all members.

Public Member Functions
	KmeansParameters ()
	Constructs a set of Kmeans parameters with default settings.
	KmeansParameters (int nm, double t, boolean pp)
	Constructs a set of Kmeans parameters with a given number of means, training threshold, and k-means++ boolean (++ is used on true, not used on false).
int	getNumMeans ()
	Accessor for the number of means.
void	setNumMeans (int nm)
	Sets the number of means.
double	getThreshold ()
	Accessor for the training threshold.
void	setThreshold (double t)
	Sets the training threshold.
boolean	getUsingPlusPlus ()
	Accessor for the k-means++ boolean.
void	setUsingPlusPlus (boolean pp)
	Sets the k-means++ boolean.
	KmeansParameters ()
	Constructs a set of Kmeans parameters with default settings.
	KmeansParameters (int nm, double t, boolean pp)
	Constructs a set of Kmeans parameters with a given number of means, training threshold, and k-means++ boolean (++ is used on true, not used on false).
int	getNumMeans ()
	Accessor for the number of means.
void	setNumMeans (int nm)
	Sets the number of means.
double	getThreshold ()
	Accessor for the training threshold.
void	setThreshold (double t)
	Sets the training threshold.
boolean	getUsingPlusPlus ()
	Accessor for the k-means++ boolean.
void	setUsingPlusPlus (boolean pp)
	Sets the k-means++ boolean.

---

Detailed Description

KmeansParameters is a simple record class for easier passing of Kmeans parameters.

It contains the number of means, the k-means algorithm training threshold, and a boolean for whether to use the ++ variant.

Author:

Team Better Recognize

---

Constructor & Destructor Documentation

KmeansParameters

(

)

Constructs a set of Kmeans parameters with default settings.

KmeansParameters	(	int	nm,
		double	t,
		boolean	pp
	)

Constructs a set of Kmeans parameters with a given number of means, training threshold, and k-means++ boolean (++ is used on true, not used on false).

Parameters:

	nm	the number of means
	t	the training threshold
	pp	whether to use k-means++ (true) or not (false)

KmeansParameters

(

)

Constructs a set of Kmeans parameters with default settings.

KmeansParameters	(	int	nm,
		double	t,
		boolean	pp
	)

Constructs a set of Kmeans parameters with a given number of means, training threshold, and k-means++ boolean (++ is used on true, not used on false).

Parameters:

	nm	the number of means
	t	the training threshold
	pp	whether to use k-means++ (true) or not (false)

---

Member Function Documentation

int getNumMeans

(

)

Accessor for the number of means.

Returns:

the nubmer of means

int getNumMeans

(

)

Accessor for the number of means.

Returns:

the nubmer of means

Here is the caller graph for this function:

double getThreshold

(

)

Accessor for the training threshold.

Returns:

the training threshold

double getThreshold

(

)

Accessor for the training threshold.

Returns:

the training threshold

Here is the caller graph for this function:

boolean getUsingPlusPlus

(

)

Accessor for the k-means++ boolean.

Returns:

whether k-means++ is being used (true) or not (false)

boolean getUsingPlusPlus

(

)

Accessor for the k-means++ boolean.

Returns:

whether k-means++ is being used (true) or not (false)

Here is the caller graph for this function:

void setNumMeans

(

int

nm

)

Sets the number of means.

Parameters:

nm

the value for setting the number of means

void setNumMeans

(

int

nm

)

Sets the number of means.

Parameters:

nm

the value for setting the number of means

void setThreshold

(

double

t

)

Sets the training threshold.

Parameters:

t

the value for setting the training threshold

void setThreshold

(

double

t

)

Sets the training threshold.

Parameters:

t

the value for setting the training threshold

void setUsingPlusPlus

(

boolean

pp

)

Sets the k-means++ boolean.

Parameters:

pp

the boolean for setting the k-means++ boolean

void setUsingPlusPlus

(

boolean

pp

)

Sets the k-means++ boolean.

Parameters:

pp

the boolean for setting the k-means++ boolean

---

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

• /Users/dev/Documents/SVN brazos.cs.tcu.edu/trunk/KmeansTest/src/KmeansParameters.java
• /Users/dev/Documents/SVN brazos.cs.tcu.edu/trunk/KmeansTestRandom/src/KmeansParameters.java