Scaler

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- samer.tools.NullTask
- - samer.models.Scaler

All Implemented Interfaces:

Model, SafeTask, Task
```
public class Scaler
extends NullTask
implements Model
```
Automatic gain control for a given input vector. Ouput appears in out. Also generates a trace of 'loudness' of input signal.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Scaler.OffsetTrainer
This trains only the offset, not the scale

class Scaler.ScaleTrainer

class Scaler.Trainer

Nested Classes
Modifier and Type	Class and Description
`class`	`Scaler.OffsetTrainer` This trains only the offset, not the scale
`class`	`Scaler.ScaleTrainer`
`class`	`Scaler.Trainer`

Constructor Summary

Constructors
Constructor and Description

Scaler(int N)

Scaler(Vec input)

Scaler(Vec input, Model M)

Constructors
Constructor and Description
`Scaler(int N)`
`Scaler(Vec input)`
`Scaler(Vec input, Model M)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`compute()` contract is that getEnergy and getGradient must return correct values for current x after infer and compute has been called, but not necessarily before.
`void`	`dispose()`
`Functionx`	`functionx()` This presents a more functional interface to the model so that it can be driven by an optimiser.
`double`	`getEnergy()` return E = -log p(x)
`double[]`	`getGradient()` return dE/dx
`VDouble`	`getOffset()`
`Scaler.OffsetTrainer`	`getOffsetTrainer()`
`Model`	`getOutputModel()`
`VDouble`	`getScale()`
`Scaler.ScaleTrainer`	`getScaleTrainer()`
`int`	`getSize()` return size of vector this model expects
`Scaler.Trainer`	`getTrainer()`
`void`	`infer()` should infer values latent variables
`VVector`	`output()`
`void`	`reset()`
`void`	`run()`
`void`	`setInput(Vec in)` model should begin observing this vector
`void`	`setOutputModel(Model m)`
`void`	`starting()`
`void`	`stopping()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Scaler
```
public Scaler(int N)
```
  - Scaler
```
public Scaler(Vec input)
```
  - Scaler
```
public Scaler(Vec input,
              Model M)
```
- Method Detail
  - getSize
```
public int getSize()
```
    Description copied from interface: Model
    
    return size of vector this model expects
    
    Specified by:
    
    getSize in interface Model
  - output
```
public VVector output()
```
  - getScale
```
public VDouble getScale()
```
  - getOffset
```
public VDouble getOffset()
```
  - getOutputModel
```
public Model getOutputModel()
```
  - setOutputModel
```
public void setOutputModel(Model m)
```
  - setInput
```
public void setInput(Vec in)
```
    Description copied from interface: Model
    
    model should begin observing this vector
    
    Specified by:
    
    setInput in interface Model
  - reset
```
public void reset()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface Model
    
    Specified by:
    
    dispose in interface Task
    
    Overrides:
    
    dispose in class NullTask
  - infer
```
public void infer()
```
    Description copied from interface: Model
    
    should infer values latent variables
    
    Specified by:
    
    infer in interface Model
  - compute
```
public void compute()
```
    Description copied from interface: Model
    
    contract is that getEnergy and getGradient must return correct values for current x after infer and compute has been called, but not necessarily before. This is to give model an opportunity to cache values of energy and gradient to avoid repeated computations.
    
    Specified by:
    
    compute in interface Model
  - getEnergy
```
public double getEnergy()
```
    Description copied from interface: Model
    
    return E = -log p(x)
    
    Specified by:
    
    getEnergy in interface Model
  - getGradient
```
public double[] getGradient()
```
    Description copied from interface: Model
    
    return dE/dx
    
    Specified by:
    
    getGradient in interface Model
  - functionx
```
public Functionx functionx()
```
    Description copied from interface: Model
    
    This presents a more functional interface to the model so that it can be driven by an optimiser. See classes Functionx and MinimiserBase in package samer.maths.opt.
    
    Specified by:
    
    functionx in interface Model
  - starting
```
public void starting()
```
    Specified by:
    
    starting in interface Task
    
    Overrides:
    
    starting in class NullTask
  - stopping
```
public void stopping()
```
    Specified by:
    
    stopping in interface Task
    
    Overrides:
    
    stopping in class NullTask
  - run
```
public void run()
```
    Specified by:
    
    run in interface SafeTask
    
    Specified by:
    
    run in interface Task
    
    Overrides:
    
    run in class NullTask
  - getTrainer
```
public Scaler.Trainer getTrainer()
```
  - getOffsetTrainer
```
public Scaler.OffsetTrainer getOffsetTrainer()
```
  - getScaleTrainer
```
public Scaler.ScaleTrainer getScaleTrainer()
```

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Java-Scheme Laboratory

Class Scaler

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Scaler

Scaler

Method Detail

getSize

output

getScale

getOffset

getOutputModel

setOutputModel

setInput

reset

toString

dispose

infer

compute

getEnergy

getGradient

functionx

starting

stopping

run

getTrainer

getOffsetTrainer

getScaleTrainer