it.uniroma2.sag.kelp.predictionfunction.model

Class BinaryLinearModel

java.lang.Object

it.uniroma2.sag.kelp.predictionfunction.model.BinaryModel

it.uniroma2.sag.kelp.predictionfunction.model.BinaryLinearModel

All Implemented Interfaces:

Model

public class BinaryLinearModel
extends BinaryModel

It is the model for a binary linear method consisting of an explicit hyperplane

Author:

Simone Filice

Field Summary

Fields inherited from class it.uniroma2.sag.kelp.predictionfunction.model.BinaryModel

bias

Constructor Summary

Constructors

Constructor and Description
BinaryLinearModel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExample(float weight, Example example) Adds an example to the model with a given weight.
Vector	getHyperplane()
String	getRepresentation()
float	getSquaredNorm() Computes the squared norm of the hyperplane this model is based on
float	getSquaredNorm(Example example) Computes the squared norm of a given example according to the space in which the model is operating
void	reset() Resets the model parameters to the default state.
void	setHyperplane(Vector hyperplane)
void	setRepresentation(String representation)

Methods inherited from class it.uniroma2.sag.kelp.predictionfunction.model.BinaryModel

getBias, setBias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BinaryLinearModel

public BinaryLinearModel()

Method Detail

getHyperplane

public Vector getHyperplane()

Returns:

the hyperplane

setHyperplane

public void setHyperplane(Vector hyperplane)

Parameters:

hyperplane - the hyperplane to set

getRepresentation

public String getRepresentation()

Returns:

the identifier of the representation on which the model operates

setRepresentation

public void setRepresentation(String representation)

Parameters:

representation - the identifier of the representation to set. The model operates on that representation

reset

public void reset()

Description copied from interface: Model

Resets the model parameters to the default state. All the learned stuff is forgotten

addExample

public void addExample(float weight,
              Example example)

Description copied from class: BinaryModel

Adds an example to the model with a given weight. The model will become a linear combination of the current model and the example

Specified by:

addExample in class BinaryModel

Parameters:

weight - the weight of the new example to add

example - the example to add

getSquaredNorm

public float getSquaredNorm(Example example)

Description copied from class: BinaryModel

Computes the squared norm of a given example according to the space in which the model is operating

Specified by:

getSquaredNorm in class BinaryModel

Parameters:

example - the example whose squared norm is required

Returns:

the squared norm of a given example

getSquaredNorm

public float getSquaredNorm()

Description copied from class: BinaryModel

Computes the squared norm of the hyperplane this model is based on

Specified by:

getSquaredNorm in class BinaryModel

Returns:

the squared norm of the hyperplane