NystromMethod (kelp-full 2.2.3 API)

Field Summary

Fields
Modifier and Type Field and Description

static float ESPILON

Fields
Modifier and Type	Field and Description
`static float`	`ESPILON`

Constructor Summary

Constructors
Constructor and Description
`NystromMethod()`
`NystromMethod(List<Example> landmarks, Kernel kernel)` Constructor of NystromMethod.
`NystromMethod(List<Example> landmarks, Kernel kernel, int expectedRank)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected double[]`	`calculateVector(Example example)` It derives an array of doubles containing the linearized representation
`int`	`getEmbeddingSize()`
`Kernel`	`getKernel()`
`List<Example>`	`getLandmarks()`
`SimpleDataset`	`getLinearizedDataset(Dataset dataset, String representationName)` This method linearizes all the examples in the input `dataset` , generating a corresponding linearized dataset.
`Example`	`getLinearizedExample(Example example, String representationName)` This method linearizes an input example, providing a new example containing only a representation with a specific name, provided as input.
`DenseVector`	`getLinearRepresentation(Example example)` Given an input `Example`, this method generates a linear `Representation>`, i.e.
`List<Double>`	`getProjectionMatrix()`
`int`	`getRank()`
`static NystromMethod`	`load(String inputFilePath)` Load a Nystrom-based projection function from a file
`void`	`save(String outputFilePath)` Save a Nystrom-based projection function in a file.
`void`	`setKernel(Kernel kernel)`
`void`	`setLandmarks(List<Example> landmarks)`
`void`	`setProjectionMatrix(List<Double> projectionMatrix)`
`void`	`setRank(int rank)`

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

- Field Detail
  - ESPILON
```
public static final float ESPILON
```
    See Also:
    Constant Field Values
- Constructor Detail
  - NystromMethod
```
public NystromMethod()
```
  - NystromMethod
```
public NystromMethod(List<Example> landmarks,
             Kernel kernel)
              throws InstantiationException
```
    Constructor of NystromMethod. The expected rank is automatically set to the size of landmarks
    
    Parameters:
    landmarks - The set of examples used as landmarks
    kernel - The kernel function
    
    Throws:
    
    InstantiationException
  - NystromMethod
```
public NystromMethod(List<Example> landmarks,
             Kernel kernel,
             int expectedRank)
              throws InstantiationException
```
    Parameters:
    landmarks - The set of examples used as landmarks
    kernel - The kernel function
    expectedRank - The expected rank of the space representing the linearized examples
    
    Throws:
    
    InstantiationException
- Method Detail
  - load
```
public static NystromMethod load(String inputFilePath)
                          throws FileNotFoundException,
                                 IOException
```
    Load a Nystrom-based projection function from a file
    
    Parameters:
    inputFilePath - the input file
    
    Returns:
    Nystrom-based projection function
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - calculateVector
```
protected double[] calculateVector(Example example)
```
    It derives an array of doubles containing the linearized representation
    
    Parameters:
    example - the input example
    
    Returns:
    the linearized representaton as array of double
  - getKernel
```
public Kernel getKernel()
```
    Returns:
    The kernel function over the implicit space linearized by the Nystrom Method
  - getLandmarks
```
public List<Example> getLandmarks()
```
    Returns:
    The examples used as landmarks
  - getLinearizedDataset
```
public SimpleDataset getLinearizedDataset(Dataset dataset,
                                 String representationName)
```
    Description copied from interface: LinearizationFunction
    
    This method linearizes all the examples in the input dataset , generating a corresponding linearized dataset. The produced examples inherit the labels of the corresponding input examples.
    
    Specified by:
    
    getLinearizedDataset in interface LinearizationFunction
    
    Parameters:
    dataset - The input dataset
    representationName - The name of the linear representation inside the new examples
    
    Returns:
  - getLinearizedExample
```
public Example getLinearizedExample(Example example,
                           String representationName)
```
    Description copied from interface: LinearizationFunction
    
    This method linearizes an input example, providing a new example containing only a representation with a specific name, provided as input. The produced example inherits the labels of the input example.
    
    Specified by:
    
    getLinearizedExample in interface LinearizationFunction
    
    Parameters:
    example - The input example.
    
    Returns:
  - getLinearRepresentation
```
public DenseVector getLinearRepresentation(Example example)
```
    Description copied from interface: LinearizationFunction
    
    Given an input Example, this method generates a linear Representation>, i.e. a Vector.
    
    Specified by:
    
    getLinearRepresentation in interface LinearizationFunction
    
    Parameters:
    example - The input example.
    
    Returns:
    The linearized representation of the input example.
  - getProjectionMatrix
```
public List<Double> getProjectionMatrix()
```
    Returns:
    The linear projection matrix used for the serialization. It is the Moore-Penrose inverse of the subset of kernel matrix estimated among landmarks
  - getRank
```
public int getRank()
```
    Returns:
    The expected rank of the space representing the linearized examples
  - save
```
public void save(String outputFilePath)
          throws FileNotFoundException,
                 IOException
```
    Save a Nystrom-based projection function in a file. If the .gz suffix is used a compressed file is obtained
    
    Parameters:
    outputFilePath - the output file path
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - setKernel
```
public void setKernel(Kernel kernel)
```
    Parameters:
    kernel - The kernel function
  - setLandmarks
```
public void setLandmarks(List<Example> landmarks)
```
    Parameters:
    landmarks - The landmarks
  - setProjectionMatrix
```
public void setProjectionMatrix(List<Double> projectionMatrix)
```
    Parameters:
    projectionMatrix - The projection matrix
  - setRank
```
public void setRank(int rank)
```
    Parameters:
    rank - The expected rank
  - getEmbeddingSize
```
public int getEmbeddingSize()
```
    Specified by:
    
    getEmbeddingSize in interface LinearizationFunction
    
    Returns:
    the size of the resulting embedding, i.e. the number of resulting vector dimensions

Class NystromMethod

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ESPILON

Constructor Detail

NystromMethod

NystromMethod

NystromMethod

Method Detail

load

calculateVector

getKernel

getLandmarks

getLinearizedDataset

getLinearizedExample

getLinearRepresentation

getProjectionMatrix

getRank

save

setKernel

setLandmarks

setProjectionMatrix

setRank

getEmbeddingSize