Yosokumo::Predictor Class Reference

A column of values, an independent variable. More...

#include <Predictor.h>

Public Types
enum	Status { ACTIVE, INACTIVE }
	Provides a logical delete facility. More...
enum	Type { CATEGORICAL, CONTINUOUS }
	Describes the quality of the predictor and determines the statistical operations that can be performed on the feature. More...
enum	Level { NOMINAL, ORDINAL, INTERVAL, RATIO }
	Indicates the level of measurement for the feature. More...
Public Member Functions
	Predictor ()
	Default constructor - initializes a newly created `Predictor` object with default attributes.
	Predictor (int64_t name)
	Initializes a newly created `Predictor` object with default attributes.
	Predictor (int64_t name, Status status, Type type, Level level)
	Initializes a newly created `Predictor` object with attributes specified by the input parameters.
	Predictor (const Predictor &rhs)
	Copy constructor - initializes a newly created `Predictor` object with a copy of another `Predictor` object.
virtual	~Predictor ()
	Destructor - destroy a `Predictor` object.
Predictor &	operator= (const Predictor &rhs)
	Assignment operator - assign one `Predictor` to another.
bool	operator== (const Predictor &rhs) const
	Equality operator - compare two `Predictors` for equality.
bool	operator!= (const Predictor &rhs) const
	Inequality operator - compare two `Predictors` for inequality.
void	setPredictorName (int64_t name)
	Set the predictor name.
int64_t	getPredictorName () const
	Return the predictor name.
void	setStatus (Status s)
	Set the predictor status.
Status	getStatus () const
	Return the predictor status.
void	setType (Type t)
	Set the predictor type.
Type	getType () const
	Return the predictor type.
void	setLevel (Level L)
	Set the predictor level.
Level	getLevel () const
	Return the predictor level.
std::string	toString ()
	Return a string representation of this `Predictor`.
Private Member Functions
void	initPredictor (int64_t name, Status status, Type type, Level level)
	Initializes a `Predictor` object with attributes specified by the input parameters.
Private Attributes
int64_t	name
Status	status
Type	type
Level	level

Detailed Description

A column of values, an independent variable.

Other terminology that is sometimes used: An attribute or an input. These are the primary characteristics of a Predictor:

a name - unsigned positive integer
a status - active or inactive
a type - categorical or continuous
a level - nominal, ordinal, interval, ratio

Author:: Roger House

Version:: 0.9

Definition at line 28 of file Predictor.h.

Member Enumeration Documentation

enum Yosokumo::Predictor::Level

Indicates the level of measurement for the feature.

The default value is RATIO.

Enumerator:

NOMINAL	the values are names or labels for certain characteristics, without any implied order among them.
ORDINAL	the feature takes values that represent the rank order of the specimen, but the distance between the values is not meaningful.
INTERVAL	the predictor values can be ranked and have a standard unit of measurement, but the zero value is arbitrary.
RATIO	The values taken by the predictor have a standard unit of measurement, are rankable, and the zero value is non-arbitrary.

Definition at line 72 of file Predictor.h.

enum Yosokumo::Predictor::Status

Provides a logical delete facility.

The default value is ACTIVE.

Enumerator:

ACTIVE	the predictor is active, i.e., it should be considered when constructing the model.
INACTIVE	the predictor is inactive, i.e., it should not be considered when constructing the model.

Definition at line 36 of file Predictor.h.

enum Yosokumo::Predictor::Type

Describes the quality of the predictor and determines the statistical operations that can be performed on the feature.

The default value is CONTINUOUS.

Enumerator: