keel.Algorithms.SVM.SMO.supportVector

Class PolyKernel

java.lang.Object

keel.Algorithms.SVM.SMO.supportVector.Kernel

keel.Algorithms.SVM.SMO.supportVector.CachedKernel

keel.Algorithms.SVM.SMO.supportVector.PolyKernel

All Implemented Interfaces:

java.io.Serializable, OptionHandler

Direct Known Subclasses:

NormalizedPolyKernel

public class PolyKernel
extends CachedKernel

The polynomial kernel : K(x, y) = <x, y>^p or K(x, y) = (<x, y>+1)^p

Valid options are:

 -D
  Enables debugging output (if available) to be printed.
  (default: off)

 -no-checks
  Turns off all checks - use with caution!
  (default: checks on)

 -C <num>
  The size of the cache (a prime number).
  (default: 250007)

 -E <num>
  The Exponent to use.
  (default: 1.0)

 -L
  Use lower-order terms.
  (default: no)

Version:

$Revision: 1.1 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz), Shane Legg (shane@intelligenesis.net) (sparse vector code), Stuart Inglis (stuart@reeltwo.com) (sparse vector code)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	m_exponent The exponent for the polynomial kernel.
protected boolean	m_lowerOrder Use lower-order terms?

Fields inherited from class keel.Algorithms.SVM.SMO.supportVector.CachedKernel

m_cacheHits, m_cacheSize, m_cacheSlots, m_kernelEvals, m_kernelMatrix, m_keys, m_numInsts, m_storage

Fields inherited from class keel.Algorithms.SVM.SMO.supportVector.Kernel

m_ChecksTurnedOff, m_data, m_Debug

Constructor Summary

Constructors

Constructor and Description
PolyKernel() default constructor - does nothing.
PolyKernel(Instances data, int cacheSize, double exponent, boolean lowerOrder) Creates a new PolyKernel instance.

Method Summary

Modifier and Type	Method and Description
protected double	evaluate(int id1, int id2, Instance inst1) This method is overridden in subclasses to implement specific kernels.
java.lang.String	exponentTipText() Returns the tip text for this property
double	getExponent() Gets the exponent value.
java.lang.String[]	getOptions() Gets the current settings of the Kernel.
boolean	getUseLowerOrder() Gets whether lower-order terms are used.
java.lang.String	globalInfo() Returns a string describing the kernel
java.util.Enumeration	listOptions() Returns an enumeration describing the available options.
void	setExponent(double value) Sets the exponent value.
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setUseLowerOrder(boolean value) Sets whether to use lower-order terms.
java.lang.String	toString() returns a string representation for the Kernel
java.lang.String	useLowerOrderTipText() Returns the tip text for this property

Methods inherited from class keel.Algorithms.SVM.SMO.supportVector.CachedKernel

buildKernel, cacheSizeTipText, clean, dotProd, eval, getCacheSize, initVars, numCacheHits, numEvals, setCacheSize

Methods inherited from class keel.Algorithms.SVM.SMO.supportVector.Kernel

checksTurnedOffTipText, debugTipText, forName, getChecksTurnedOff, getDebug, makeCopies, makeCopy, setChecksTurnedOff, setDebug

Methods inherited from class java.lang.Object

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

Field Detail

m_lowerOrder

protected boolean m_lowerOrder

Use lower-order terms?

m_exponent

protected double m_exponent

The exponent for the polynomial kernel.

Constructor Detail

PolyKernel

public PolyKernel()

default constructor - does nothing.

PolyKernel

public PolyKernel(Instances data,
                  int cacheSize,
                  double exponent,
                  boolean lowerOrder)
           throws java.lang.Exception

Creates a new PolyKernel instance.

Parameters:

data - the training dataset used.

cacheSize - the size of the cache (a prime number)

exponent - the exponent to use

lowerOrder - whether to use lower-order terms

Throws:

java.lang.Exception - if something goes wrong

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing the kernel

Specified by:

globalInfo in class Kernel

Returns:

a description suitable for displaying in the explorer/experimenter gui

listOptions

public java.util.Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class CachedKernel

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Valid options are:

 -D
  Enables debugging output (if available) to be printed.
  (default: off)

 -no-checks
  Turns off all checks - use with caution!
  (default: checks on)

 -C <num>
  The size of the cache (a prime number).
  (default: 250007)

 -E <num>
  The Exponent to use.
  (default: 1.0)

 -L
  Use lower-order terms.
  (default: no)

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class CachedKernel

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the Kernel.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class CachedKernel

Returns:

an array of strings suitable for passing to setOptions

evaluate

protected double evaluate(int id1,
                          int id2,
                          Instance inst1)
                   throws java.lang.Exception

Description copied from class: CachedKernel

This method is overridden in subclasses to implement specific kernels.

Specified by:

evaluate in class CachedKernel

Parameters:

id1 - the index of instance 1

id2 - the index of instance 2

inst1 - the instance 1 object

Returns:

the dot product

Throws:

java.lang.Exception - if something goes wrong

setExponent

public void setExponent(double value)

Sets the exponent value.

Parameters:

value - the exponent value

getExponent

public double getExponent()

Gets the exponent value.

Returns:

the exponent value

exponentTipText

public java.lang.String exponentTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setUseLowerOrder

public void setUseLowerOrder(boolean value)

Sets whether to use lower-order terms.

Parameters:

value - true if lower-order terms will be used

getUseLowerOrder

public boolean getUseLowerOrder()

Gets whether lower-order terms are used.

Returns:

true if lower-order terms are used

useLowerOrderTipText

public java.lang.String useLowerOrderTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

toString

public java.lang.String toString()

returns a string representation for the Kernel

Overrides:

toString in class java.lang.Object

Returns:

a string representaiton of the kernel