StickTransform (PULsE 1.98 API)

java.lang.Object
- pulse.math.transforms.BoundedParameterTransform
- - pulse.math.transforms.StickTransform

All Implemented Interfaces:

Serializable, Transformable
```
public class StickTransform
extends BoundedParameterTransform
```
A simple bounded transform which makes the parameter stick to the boundaries upon reaching them. For insatnce, when a parameter $x$ attempts to escape its bounds due to a larger increment then allowed, this transform will return it directly to the respective boundary, where it will "stick".

Author:

Artem Lunev

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

StickTransform(Segment bounds)
Only the upper bound of the argument is used.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`inverse(double t)`	Inverses the transform.
`double`	`transform(double a)`	Performs the selected transform with `value`

Methods inherited from class pulse.math.transforms.BoundedParameterTransform
getBounds, setBounds

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

- Constructor Detail
  - StickTransform
```
public StickTransform(Segment bounds)
```
    Only the upper bound of the argument is used.
    
    Parameters:
    
    bounds - the bounda.getMaximum() is used in the transforms
- Method Detail
  - transform
```
public double transform(double a)
```
    Description copied from interface: Transformable
    
    Performs the selected transform with value
    
    Parameters:
    
    a -
    
    Returns:
    
    the results, such that inverse( transform(value) ) = value
  - inverse
```
public double inverse(double t)
```
    Description copied from interface: Transformable
    
    Inverses the transform.