DataPoint (Java Statistical Analysis Tool 0.0.8 API)

java.lang.Object
- jsat.classifiers.DataPoint

All Implemented Interfaces:

Serializable, Cloneable
```
public class DataPoint
extends Object
implements Cloneable, Serializable
```
This is the general class object for representing a singular data point in a data set. Every data point is made up of either categorical variables, numerical variables, or a combination of the two.

Author:

Edward Raff

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected CategoricalData[] categoricalData

protected int[] categoricalValues

protected Vec numericalValues

Fields
Modifier and Type	Field and Description
`protected CategoricalData[]`	`categoricalData`
`protected int[]`	`categoricalValues`
`protected Vec`	`numericalValues`

Constructor Summary

Constructors
Constructor and Description
`DataPoint(Vec numericalValues)` Creates a new data point that has no categorical variables and a weight of 1.0
`DataPoint(Vec numericalValues, double weight)` Creates a new data point that has no categorical variables
`DataPoint(Vec numericalValues, int[] categoricalValues, CategoricalData[] categoricalData)` Creates a new data point with the default weight of 1.0
`DataPoint(Vec numericalValues, int[] categoricalValues, CategoricalData[] categoricalData, double weight)` Creates a new data point

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataPoint`	`clone()` Creates a deep clone of this data point, such that altering either data point does not effect the other one.
`boolean`	`containsCategoricalData()` Returns true if this data point contains any categorical variables, false otherwise.
`boolean`	`containsNumericalData()` Returns true if the data point contains any numerical variables, false otherwise.
`CategoricalData[]`	`getCategoricalData()` Returns the array of Categorical Data information
`int`	`getCategoricalValue(int i)`
`int[]`	`getCategoricalValues()` Returns the array of values for each category.
`Vec`	`getNumericalValues()` Returns the vector containing the numerical values.
`double`	`getWeight()` Returns the weight that this data point carries.
`int`	`numCategoricalValues()` Returns the number of categorical variables in this data point.
`int`	`numNumericalValues()` Returns the number of numerical variables in this data point.
`void`	`setWeight(double weight)` Set the weight that this data point should carry.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - numericalValues
```
protected Vec numericalValues
```
  - categoricalValues
```
protected int[] categoricalValues
```
  - categoricalData
```
protected CategoricalData[] categoricalData
```
- Constructor Detail
  - DataPoint
```
public DataPoint(Vec numericalValues,
                 int[] categoricalValues,
                 CategoricalData[] categoricalData)
```
    Creates a new data point with the default weight of 1.0
    
    Parameters:
    
    numericalValues - a vector containing the numerical values for this data point
    
    categoricalValues - an array of the category values for this data point
    
    categoricalData - an array of the category information of this data point
  - DataPoint
```
public DataPoint(Vec numericalValues,
                 int[] categoricalValues,
                 CategoricalData[] categoricalData,
                 double weight)
```
    Creates a new data point
    
    Parameters:
    
    numericalValues - a vector containing the numerical values for this data point
    
    categoricalValues - an array of the category values for this data point
    
    categoricalData - an array of the category information of this data point
    
    weight - a double indicating how much weight this data point has, 1.0 being the standard weight. Not all algorithms make use of data points that have different weights.
  - DataPoint
```
public DataPoint(Vec numericalValues,
                 double weight)
```
    Creates a new data point that has no categorical variables
    
    Parameters:
    
    numericalValues - a vector containing the numerical values for this data point
    
    weight - a double indicating how much weight this data point has, 1.0 being the standard weight. Not all algorithms make use of data points that have different weights.
  - DataPoint
```
public DataPoint(Vec numericalValues)
```
    Creates a new data point that has no categorical variables and a weight of 1.0
    
    Parameters:
    
    numericalValues - a vector containing the numerical values for this data point
- Method Detail
  - getWeight
```
public double getWeight()
```
    Returns the weight that this data point carries.
    
    Returns:
    
    the weight that this data point carries.
  - setWeight
```
public void setWeight(double weight)
```
    Set the weight that this data point should carry. The norm is 1.0
    
    Parameters:
    
    weight - the new weight value
    
    Throws:
    
    ArithmeticException - if the weight value is not a number > 0
  - containsCategoricalData
```
public boolean containsCategoricalData()
```
    Returns true if this data point contains any categorical variables, false otherwise.
    
    Returns:
    
    true if this data point contains any categorical variables, false otherwise.
  - getNumericalValues
```
public Vec getNumericalValues()
```
    Returns the vector containing the numerical values. Altering this vector will effect this data point. If changes are going to be made, a clone of the vector should be made by the caller.
    
    Returns:
    
    the vector containing the numerical values.
  - containsNumericalData
```
public boolean containsNumericalData()
```
    Returns true if the data point contains any numerical variables, false otherwise.
    
    Returns:
    
    true if the data point contains any numerical variables, false otherwise.
  - numNumericalValues
```
public int numNumericalValues()
```
    Returns the number of numerical variables in this data point.
    
    Returns:
    
    the number of numerical variables in this data point.
  - getCategoricalValues
```
public int[] getCategoricalValues()
```
    Returns the array of values for each category. Altering this array will effect this data point. If changes are going to be made, a clone of the array should be made by the caller.
    
    Returns:
    
    the array of values for each category.
  - numCategoricalValues
```
public int numCategoricalValues()
```
    Returns the number of categorical variables in this data point.
    
    Returns:
    
    the number of categorical variables in this data point.
  - getCategoricalValue
```
public int getCategoricalValue(int i)
```
    Parameters:
    
    i - the i'th categorical variable
    
    Returns:
    
    the value of the i'th categorical variable
  - getCategoricalData
```
public CategoricalData[] getCategoricalData()
```
    Returns the array of Categorical Data information
    
    Returns:
    
    the array of Categorical Data information
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public DataPoint clone()
```
    Creates a deep clone of this data point, such that altering either data point does not effect the other one.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a deep clone of this data point.

Class DataPoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numericalValues

categoricalValues

categoricalData

Constructor Detail

DataPoint

DataPoint

DataPoint

DataPoint

Method Detail

getWeight

setWeight

containsCategoricalData

getNumericalValues

containsNumericalData

numNumericalValues

getCategoricalValues

numCategoricalValues

getCategoricalValue

getCategoricalData

toString

clone