ArcX4 (Java Statistical Analysis Tool 0.0.8 API)

java.lang.Object
- jsat.classifiers.boosting.ArcX4

All Implemented Interfaces:

Serializable, Cloneable, Classifier, Parameterized
```
public class ArcX4
extends Object
implements Classifier, Parameterized
```
Arc-x4 is a ensemble-classifier that performs re-weighting of the data points based on the total number of errors that have occurred for the data point.

See: Breiman, L. (1998). Arcing Classifiers. The Annals of Statistics, 26(3), 801–824.

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ArcX4(Classifier weakLearner, int iterations)
Creates a new Arc-X4 classifier

Constructors
Constructor and Description
`ArcX4(Classifier weakLearner, int iterations)` Creates a new Arc-X4 classifier

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CategoricalResults`	`classify(DataPoint data)` Performs classification on the given data point.
`ArcX4`	`clone()`
`double`	`getCoefficient()` Returns the coefficient use when re-weighting
`double`	`getExponent()` Returns the exponent used when re-weighting
`int`	`getIterations()` Returns the number of iterations to learn
`Parameter`	`getParameter(String paramName)` Returns the parameter with the given name.
`List<Parameter>`	`getParameters()` Returns the list of parameters that can be altered for this learner.
`Classifier`	`getWeakLearner()` Returns the weak learner used
`void`	`setCoefficient(double coef)` Weights are updated as 1+coef*errors^expo.
`void`	`setExponent(double expo)` Weights are updated as 1+coef*errors^expo.
`void`	`setIterations(int iterations)` Sets the number of iterations to perform
`void`	`setWeakLearner(Classifier weakLearner)` Sets the weak learner used at each iteration of learning
`boolean`	`supportsWeightedData()` Indicates whether the model knows how to train using weighted data points.
`void`	`trainC(ClassificationDataSet dataSet)` Trains the classifier and constructs a model for classification using the given data set.
`void`	`trainC(ClassificationDataSet dataSet, ExecutorService threadPool)` Trains the classifier and constructs a model for classification using the given data set.

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

- Constructor Detail
  - ArcX4
```
public ArcX4(Classifier weakLearner,
             int iterations)
```
    Creates a new Arc-X4 classifier
    
    Parameters:
    
    weakLearner - the weak learner to use
    
    iterations - the number of iterations to perform
- Method Detail
  - setWeakLearner
```
public void setWeakLearner(Classifier weakLearner)
```
    Sets the weak learner used at each iteration of learning
    
    Parameters:
    
    weakLearner - the weak learner to use
  - getWeakLearner
```
public Classifier getWeakLearner()
```
    Returns the weak learner used
    
    Returns:
    
    the weak learner used
  - setIterations
```
public void setIterations(int iterations)
```
    Sets the number of iterations to perform
    
    Parameters:
    
    iterations - the number of iterations to do
  - getIterations
```
public int getIterations()
```
    Returns the number of iterations to learn
    
    Returns:
    
    the number of iterations to learn
  - setCoefficient
```
public void setCoefficient(double coef)
```
    Weights are updated as 1+coef*errors^expo. This sets the coefficient used to update the errors
    
    Parameters:
    
    coef - the multiplicative factor on the errors in weight construction
  - getCoefficient
```
public double getCoefficient()
```
    Returns the coefficient use when re-weighting
    
    Returns:
    
    the coefficient use when re-weighting
  - setExponent
```
public void setExponent(double expo)
```
    Weights are updated as 1+coef*errors^expo. This sets the exponent used to update the errors
    
    Parameters:
    
    expo - the exponent to use
  - getExponent
```
public double getExponent()
```
    Returns the exponent used when re-weighting
    
    Returns:
    
    the exponent used when re-weighting
  - classify
```
public CategoricalResults classify(DataPoint data)
```
    Description copied from interface: Classifier
    
    Performs classification on the given data point.
    
    Specified by:
    
    classify in interface Classifier
    
    Parameters:
    
    data - the data point to classify
    
    Returns:
    
    the results of the classification.
  - trainC
```
public void trainC(ClassificationDataSet dataSet,
                   ExecutorService threadPool)
```
    Description copied from interface: Classifier
    
    Trains the classifier and constructs a model for classification using the given data set. If the training method knows how, it will used the threadPool to conduct training in parallel. This method will block until the training has completed.
    
    Specified by:
    
    trainC in interface Classifier
    
    Parameters:
    
    dataSet - the data set to train on
    
    threadPool - the source of threads to use.
  - trainC
```
public void trainC(ClassificationDataSet dataSet)
```
    Description copied from interface: Classifier
    
    Trains the classifier and constructs a model for classification using the given data set.
    
    Specified by:
    
    trainC in interface Classifier
    
    Parameters:
    
    dataSet - the data set to train on
  - supportsWeightedData
```
public boolean supportsWeightedData()
```
    Description copied from interface: Classifier
    
    Indicates whether the model knows how to train using weighted data points. If it does, the model will train assuming the weights. The values returned by this method may change depending on the parameters set for the model.
    
    Specified by:
    
    supportsWeightedData in interface Classifier
    
    Returns:
    
    true if the model supports weighted data, false otherwise
  - clone
```
public ArcX4 clone()
```
    Specified by:
    
    clone in interface Classifier
    
    Overrides:
    
    clone in class Object
  - getParameters
```
public List<Parameter> getParameters()
```
    Description copied from interface: Parameterized
    
    Returns the list of parameters that can be altered for this learner.
    
    Specified by:
    
    getParameters in interface Parameterized
    
    Returns:
    
    the list of parameters that can be altered for this learner.
  - getParameter
```
public Parameter getParameter(String paramName)
```
    Description copied from interface: Parameterized
    
    Returns the parameter with the given name. Two different strings may map to a single Parameter object. An ASCII only string, and a Unicode style string.
    
    Specified by:
    
    getParameter in interface Parameterized
    
    Parameters:
    
    paramName - the name of the parameter to obtain
    
    Returns:
    
    the Parameter in question, or null if no such named Parameter exists.

Class ArcX4

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArcX4

Method Detail

setWeakLearner

getWeakLearner

setIterations

getIterations

setCoefficient

getCoefficient

setExponent

getExponent

classify

trainC

trainC

supportsWeightedData

clone

getParameters

getParameter