JDFNumList (JDFLibJ 2.1.7.1 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector<java.lang.Object>
    - - org.cip4.jdflib.datatypes.JDFNumList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, java.util.RandomAccess, JDFBaseDataTypes

Direct Known Subclasses:

JDFCMYKColor, JDFIntegerList, JDFLabColor, JDFMatrix, JDFNumberList, JDFRectangle, JDFRGBColor, JDFShape, JDFTransferFunction, JDFXYPair
```
public abstract class JDFNumList
extends java.util.Vector<java.lang.Object>
implements JDFBaseDataTypes, java.lang.Cloneable
```
This abstract class is the representation of a number list (Integer and Double object). Intern these objects are collected in a vector and there are several methods to provide an access to the data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JDFNumList.NormComparator

static class JDFNumList.VolumeComparator
- Nested classes/interfaces inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes
  JDFBaseDataTypes.EnumFitsValue

Nested Classes
Modifier and Type	Class and Description
`static class`	`JDFNumList.NormComparator`
`static class`	`JDFNumList.VolumeComparator`

Field Summary
- Fields inherited from class java.util.Vector
  capacityIncrement, elementCount, elementData
- Fields inherited from class java.util.AbstractList
  modCount
- Fields inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes
  EPSILON, MAX_CMYK_COLOR, MAX_LAB_COLOR, MAX_MATRIX_DIMENSION, MAX_RECTANGLE_DIMENSION, MAX_RGB_COLOR, MAX_SHAPE_DIMENSION, MAX_XY_DIMENSION

Constructor Summary

Constructors
Constructor and Description
`JDFNumList()` constructs an empty number list
`JDFNumList(double[] array)` constructor - constructs a number list with the given size and sets all values set to 0.0 Double
`JDFNumList(int size)` constructor - constructs a number list with the given size and sets all values set to 0.0 Double
`JDFNumList(int[] array)` constructor - constructs a number list with the given size and sets all values set to 0.0 Double
`JDFNumList(JDFNumList nl)` constructor - constructs a number list with a given JDFNumList
`JDFNumList(java.lang.String sl)` constructor - constructs a number list with the given String; if the sub class is of type JDFIntegerList all object will be Integer in all other cases the object will be a Double
`JDFNumList(java.util.Vector v)` Deprecated. use typesafe constructors

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JDFNumList`	`abs()` modify numlist to absolute values
`JDFNumList`	`clone()`
`boolean`	`contains(JDFNumList l)` return true if this contains at least one element from l
`boolean`	`containsAll(JDFNumList l)` return true if this contains all elements from l
`java.util.Vector<java.lang.Object>`	`copyNumList()` Deprecated. use clone()
`double`	`doubleAt(int i)` getElementAt - returns the element at the ith position
`java.lang.Object`	`elementAt(int i)` getElementAt - returns the element at the ith position
`boolean`	`equals(java.lang.Object other)` equals - compares two JDFNumList elements
`java.lang.Double`	`getDouble(int i)`
`double[]`	`getDoubleList()` get the list of values as doubles
`java.util.Vector<java.lang.Double>`	`getDoubleVector()` get the list of values as doubles
`int[]`	`getIntArray()` getIntArray - returns this integer list as an int array
`java.lang.String`	`getString()` Deprecated. 060418 - use toString
`java.lang.String`	`getString(int precision)` getString - returns the JDFNumList as a String
`int`	`hashCode()` hashCode complements equals() to fulfill the equals/hashCode contract
`int`	`intAt(int i)` getElementAt - returns the element at the ith position
`abstract boolean`	`isValid()` isValid - true if all instances are Double or Integer types
`boolean`	`isValidString(java.lang.String st)` isValidString - true if all instances are Double or Integer types
`boolean`	`matches(JDFNumList other, double delta)` are all values within +/- delta?
`double`	`max()` return the absolute norm (sqrt of sum of values)
`double`	`min()` return the absolute norm (sqrt of sum of values)
`double`	`norm()` return the absolute norm (sqrt of sum of values)
`void`	`removeElementAt(int i)` removeElementAt - removes the element at the given position
`boolean`	`replaceElementAt(java.lang.Object obj, int i)` replaceElementAt - replaces the element at the given position with the given object
`JDFNumList`	`scale(double factor)` scale all values of this by factor
`JDFNumList`	`scale(double factor, int precision)` scale all values of this by factor
`JDFNumList`	`scaleFromCM()` scale all values of this to points from centimeters
`JDFNumList`	`scaleFromCM(int precision)` scale all values of this to points from centimeters
`JDFNumList`	`scaleFromMM()` scale all values of this to points from millimeters
`JDFNumList`	`scaleFromMM(int precision)` scale all values of this to points from millimeters
`JDFNumList`	`scaleToCM()` scale all values of this to points from centimeters
`JDFNumList`	`scaleToCM(int precision)` scale all values of this to points from centimeters
`JDFNumList`	`scaleToMM()` scale all values of this to points from millimeters
`JDFNumList`	`scaleToMM(int precision)` scale all values of this to points from millimeters
`void`	`set(int pos, double d)`
`JDFNumList`	`setString(java.lang.String string)` sets this to the value specified in string
`JDFNumList`	`setX(int pos, double d)`
`JDFNumList`	`shift(double x)` return the absolute norm (sqrt of sum of values)
`void`	`sort()`
`JDFNumList`	`subtract(JDFNumList l)` subtract l from this,
`java.lang.String`	`toString()` toString - returns the JDFNumList as a String
`void`	`unify()` ensure that each instance exists only once
`double`	`volume()` return the n dimensional volume (product of all values)

Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elements, ensureCapacity, firstElement, forEach, get, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, trimToSize

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

Methods inherited from interface java.util.Collection
parallelStream, stream

- Constructor Detail
  - JDFNumList
```
public JDFNumList()
```
    constructs an empty number list
  - JDFNumList
```
public JDFNumList(int size)
```
    constructor - constructs a number list with the given size and sets all values set to 0.0 Double
    
    Parameters:
    
    size - the given size
  - JDFNumList
```
public JDFNumList(int[] array)
```
    constructor - constructs a number list with the given size and sets all values set to 0.0 Double
    
    Parameters:
    
    size - the given size
  - JDFNumList
```
public JDFNumList(double[] array)
```
    constructor - constructs a number list with the given size and sets all values set to 0.0 Double
    
    Parameters:
    
    size - the given size
  - JDFNumList
```
@Deprecated
public JDFNumList(java.util.Vector v)
                       throws java.util.zip.DataFormatException
```
    Deprecated. use typesafe constructors
    
    constructor - constructs a number list with the given vector
    
    Parameters:
    
    v - a vector with number list objects
    
    Throws:
    
    java.util.zip.DataFormatException - - if the Vector has not a valid format
  - JDFNumList
```
public JDFNumList(java.lang.String sl)
           throws java.util.zip.DataFormatException
```
    constructor - constructs a number list with the given String; if the sub class is of type JDFIntegerList all object will be Integer in all other cases the object will be a Double
    
    Parameters:
    
    sl - the given String
    
    Throws:
    
    java.util.zip.DataFormatException - - if the String has not a valid format
  - JDFNumList
```
public JDFNumList(JDFNumList nl)
           throws java.util.zip.DataFormatException
```
    constructor - constructs a number list with a given JDFNumList
    
    Parameters:
    
    nl - the given number list
    
    Throws:
    
    java.util.zip.DataFormatException - - if the String has not a valid format
- Method Detail
  - set
```
public void set(int pos,
                double d)
```
    Parameters:
    
    pos -
    
    d -
  - setX
```
public JDFNumList setX(int pos,
                       double d)
```
    Parameters:
    
    pos -
    
    d -
  - setString
```
public JDFNumList setString(java.lang.String string)
                     throws java.util.zip.DataFormatException
```
    sets this to the value specified in string
    
    Parameters:
    
    string -
    
    Throws:
    
    java.util.zip.DataFormatException
  - getString
```
@Deprecated
public java.lang.String getString()
```
    Deprecated. 060418 - use toString
    
    getString - returns all values whitespace separated in a String
    
    Returns:
    
    String
  - getDoubleList
```
public double[] getDoubleList()
```
    get the list of values as doubles
    
    Returns:
  - getDoubleVector
```
public java.util.Vector<java.lang.Double> getDoubleVector()
```
    get the list of values as doubles
    
    Returns:
  - toString
```
public java.lang.String toString()
```
    toString - returns the JDFNumList as a String
    
    Overrides:
    
    toString in class java.util.Vector<java.lang.Object>
    
    Returns:
    
    String - the JDFNumList as a String
  - getString
```
public java.lang.String getString(int precision)
```
    getString - returns the JDFNumList as a String
    
    Parameters:
    
    precision - # of digits to print
    
    Returns:
    
    String - the JDFNumList as a String
  - equals
```
public boolean equals(java.lang.Object other)
```
    equals - compares two JDFNumList elements
    
    Specified by:
    
    equals in interface java.util.Collection<java.lang.Object>
    
    Specified by:
    
    equals in interface java.util.List<java.lang.Object>
    
    Overrides:
    
    equals in class java.util.Vector<java.lang.Object>
    
    Returns:
    
    boolean - true if equal otherwise false
  - hashCode
```
public int hashCode()
```
    hashCode complements equals() to fulfill the equals/hashCode contract
    
    Specified by:
    
    hashCode in interface java.util.Collection<java.lang.Object>
    
    Specified by:
    
    hashCode in interface java.util.List<java.lang.Object>
    
    Overrides:
    
    hashCode in class java.util.Vector<java.lang.Object>
  - elementAt
```
public java.lang.Object elementAt(int i)
```
    getElementAt - returns the element at the ith position
    
    Overrides:
    
    elementAt in class java.util.Vector<java.lang.Object>
    
    Parameters:
    
    i - the index
    
    Returns:
    
    Object - the range object at the given position, null if i is out of range
  - doubleAt
```
public double doubleAt(int i)
```
    getElementAt - returns the element at the ith position
    
    Parameters:
    
    i - the index
    
    Returns:
    
    double - the double value given position, 0.0 if out of range
  - intAt
```
public int intAt(int i)
```
    getElementAt - returns the element at the ith position
    
    Parameters:
    
    i - the index
    
    Returns:
    
    double - the double value given position, 0.0 if out of range
  - copyNumList
```
@Deprecated
public java.util.Vector<java.lang.Object> copyNumList()
```
    Deprecated. use clone()
    
    copyNumList - returns a clone of the numList vector
    
    Returns:
    
    Vector - the clone of the numList vector
  - removeElementAt
```
public void removeElementAt(int i)
```
    removeElementAt - removes the element at the given position
    
    Overrides:
    
    removeElementAt in class java.util.Vector<java.lang.Object>
    
    Parameters:
    
    i - the position from where to remove the element
  - replaceElementAt
```
public boolean replaceElementAt(java.lang.Object obj,
                                int i)
```
    replaceElementAt - replaces the element at the given position with the given object
    
    Parameters:
    
    obj - the object
    
    i - the given position
    
    Returns:
    
    boolean - true if successful otherwise false
  - isValid
```
public abstract boolean isValid()
                         throws java.util.zip.DataFormatException
```
    isValid - true if all instances are Double or Integer types
    
    Returns:
    
    boolean - true if all instances are Double or Integer types
    
    Throws:
    
    java.util.zip.DataFormatException
  - isValidString
```
public boolean isValidString(java.lang.String st)
```
    isValidString - true if all instances are Double or Integer types
    
    Parameters:
    
    st - the string to check
    
    Returns:
    
    boolean - true if all instances are Double or Integer types
  - scaleFromMM
```
public JDFNumList scaleFromMM()
```
    scale all values of this to points from millimeters
    
    Returns:
  - scaleFromMM
```
public JDFNumList scaleFromMM(int precision)
```
    scale all values of this to points from millimeters
    
    Returns:
  - scaleFromCM
```
public JDFNumList scaleFromCM()
```
    scale all values of this to points from centimeters
    
    Returns:
  - scaleFromCM
```
public JDFNumList scaleFromCM(int precision)
```
    scale all values of this to points from centimeters
    
    Returns:
  - scaleToMM
```
public JDFNumList scaleToMM()
```
    scale all values of this to points from millimeters
    
    Returns:
  - scaleToMM
```
public JDFNumList scaleToMM(int precision)
```
    scale all values of this to points from millimeters
    
    Returns:
  - scaleToCM
```
public JDFNumList scaleToCM()
```
    scale all values of this to points from centimeters
    
    Returns:
  - scaleToCM
```
public JDFNumList scaleToCM(int precision)
```
    scale all values of this to points from centimeters
    
    Returns:
  - scale
```
public JDFNumList scale(double factor)
```
    scale all values of this by factor
    
    Parameters:
    
    factor -
    
    Returns:
  - scale
```
public JDFNumList scale(double factor,
                        int precision)
```
    scale all values of this by factor
    
    Parameters:
    
    factor -
    
    Returns:
  - abs
```
public JDFNumList abs()
```
    modify numlist to absolute values
    
    Returns:
    
    See Also:
    
    Math.abs(int)
  - clone
```
public JDFNumList clone()
```
    Overrides:
    
    clone in class java.util.Vector<java.lang.Object>
    
    See Also:
    
    Vector.clone()
  - matches
```
public boolean matches(JDFNumList other,
                       double delta)
```
    are all values within +/- delta?
    
    Parameters:
    
    other -
    
    delta -
    
    Returns:
    
    See Also:
    
    Math.abs(int)
  - subtract
```
public JDFNumList subtract(JDFNumList l)
```
    subtract l from this,
    
    Parameters:
    
    l - the list to subtract from this
    
    Throws:
    
    java.lang.IllegalArgumentException - if sizes don't match
  - unify
```
public void unify()
```
    ensure that each instance exists only once
  - getIntArray
```
public int[] getIntArray()
```
    getIntArray - returns this integer list as an int array
    
    Returns:
    
    int[] - the int array
  - getDouble
```
public java.lang.Double getDouble(int i)
```
    Parameters:
    
    i -
    
    Returns:
    
    the Double object
  - sort
```
public void sort()
```
  - contains
```
public boolean contains(JDFNumList l)
```
    return true if this contains at least one element from l
    
    Parameters:
    
    l - the list to check for
    
    Returns:
  - norm
```
public double norm()
```
    return the absolute norm (sqrt of sum of values)
    
    Returns:
  - min
```
public double min()
```
    return the absolute norm (sqrt of sum of values)
    
    Returns:
  - shift
```
public JDFNumList shift(double x)
```
    return the absolute norm (sqrt of sum of values)
    
    Returns:
  - max
```
public double max()
```
    return the absolute norm (sqrt of sum of values)
    
    Returns:
  - volume
```
public double volume()
```
    return the n dimensional volume (product of all values)
    
    Returns:
  - containsAll
```
public boolean containsAll(JDFNumList l)
```
    return true if this contains all elements from l
    
    Parameters:
    
    l - the list to check for
    
    Returns:

Class JDFNumList

Nested Class Summary

Nested classes/interfaces inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

Field Summary

Fields inherited from class java.util.Vector

Fields inherited from class java.util.AbstractList

Fields inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

Constructor Summary

Method Summary

Methods inherited from class java.util.Vector

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Constructor Detail

JDFNumList

JDFNumList

JDFNumList

JDFNumList

JDFNumList

JDFNumList

JDFNumList

Method Detail

set

setX

setString

getString

getDoubleList

getDoubleVector

toString

getString

equals

hashCode

elementAt

doubleAt

intAt

copyNumList

removeElementAt

replaceElementAt

isValid

isValidString

scaleFromMM

scaleFromMM

scaleFromCM

scaleFromCM

scaleToMM

scaleToMM

scaleToCM

scaleToCM

scale

scale

abs

clone

matches

subtract

unify

getIntArray

getDouble

sort

contains

norm

min

shift

max

volume

containsAll