Triplet

java.lang.Object
- triana.types.util.Triplet

All Implemented Interfaces:

java.io.Serializable
```
public class Triplet
extends java.lang.Object
implements java.io.Serializable
```
Triplet is an Object containing three numbers that can generate a uniform sequence of numbers, which can be used to represent an array index or an independent variable in, say, graphical applications. The elements of Triplet are numbers giving the integer length of the sequence and the doubles start and step of the sequence. Various methods are provided for creating and reading Triplets and converting them to equivalent arrays of numbers.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Triplet()` Constructs an empty Triplet.
`Triplet(double[] array)` Constructs a Triplet from an array of doubles that should contain a uniformly spaced set of values.
`Triplet(int l)` Constructs a Triplet with the specified length and default values of start (0) and step (1).
`Triplet(int l, double st)` Constructs a Triplet with the specified length and starting value, and with a default value of the step (1).
`Triplet(int l, double st, double sp)` Constructs a Triplet with the specified length, start, and step.

Method Summary

Methods
Modifier and Type	Method and Description
`double[]`	`convertToArray()` Returns an array of doubles generated by the Triplet.
`static Triplet`	`convertToTriplet(double[] values)` Class method that converts a uniformly spaced one-dimensional array of doubles to a Triplet.
`Triplet`	`copy()` Copy by value not by reference
`double`	`getLast()` Returns the last element of the sequence generated by the Triplet.
`int`	`getLength()` Returns the length element of the Triplet.
`double`	`getStart()` Returns the start element of the Triplet.
`double`	`getStep()` Returns the step element of the Triplet.
`void`	`setLength(int l)` Sets the length element of the Triplet.
`void`	`setStart(double st)` Sets the start element of the Triplet.
`void`	`setStep(double sp)` Sets the step element of the Triplet.
`static boolean`	`testUniform(double[] values)` Class method that tests a one-dimensional array to see if it is uniform and can therefore be converted to a Triplet.
`java.lang.String`	`toAColumn()`
`java.lang.String`	`toAString()`

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

- Constructor Detail
  - Triplet
```
public Triplet()
```
    Constructs an empty Triplet. capacity and the specified capacityIncrement.
  - Triplet
```
public Triplet(int l,
       double st,
       double sp)
```
    Constructs a Triplet with the specified length, start, and step.
    
    Parameters:
    l - The number of elements in the uniformly spaced set.
    st - The first value of the set.
    sp - The interval (uniform) between values in the set.
  - Triplet
```
public Triplet(int l)
```
    Constructs a Triplet with the specified length and default values of start (0) and step (1).
    
    Parameters:
    l - The number of elements in the uniformly spaced set.
  - Triplet
```
public Triplet(int l,
       double st)
```
    Constructs a Triplet with the specified length and starting value, and with a default value of the step (1).
    
    Parameters:
    l - The number of elements in the uniformly spaced set.
    st - The first value of the set.
  - Triplet
```
public Triplet(double[] array)
```
    Constructs a Triplet from an array of doubles that should contain a uniformly spaced set of values. Users are responsible for testing the array using method testUniform, below.
- Method Detail
  - getLength
```
public int getLength()
```
    Returns the length element of the Triplet.
  - getStart
```
public double getStart()
```
    Returns the start element of the Triplet.
  - getStep
```
public double getStep()
```
    Returns the step element of the Triplet.
  - getLast
```
public double getLast()
```
    Returns the last element of the sequence generated by the Triplet.
  - setLength
```
public void setLength(int l)
```
    Sets the length element of the Triplet.
  - setStart
```
public void setStart(double st)
```
    Sets the start element of the Triplet.
  - setStep
```
public void setStep(double sp)
```
    Sets the step element of the Triplet.
  - convertToArray
```
public double[] convertToArray()
```
    Returns an array of doubles generated by the Triplet.
  - testUniform
```
public static boolean testUniform(double[] values)
```
    Class method that tests a one-dimensional array to see if it is uniform and can therefore be converted to a Triplet. TODO - ADDED BY ANDREW 12.08.10 - have I broken this?
  - convertToTriplet
```
public static Triplet convertToTriplet(double[] values)
```
    Class method that converts a uniformly spaced one-dimensional array of doubles to a Triplet. This does not test whether the array is uniform: use method testUniform to do that. It just uses the first values and length of the array to generate the Triplet.
  - toAString
```
public final java.lang.String toAString()
```
    Returns:
    a string representation of this Triplet in the form :-
    el0 el1 el2 \n
  - toAColumn
```
public final java.lang.String toAColumn()
```
    Returns:
    a string representation of this Triplet in the form :-
    el0 \n el1 \n el2 \n
  - copy
```
public Triplet copy()
```
    Copy by value not by reference

Class Triplet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Triplet

Triplet

Triplet

Triplet

Triplet

Method Detail

getLength

getStart

getStep

getLast

setLength

setStart

setStep

convertToArray

testUniform

convertToTriplet

toAString

toAColumn

copy