Real2Array (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.Real2Array

All Implemented Interfaces:

Iterable<Real2>, EuclidConstants
```
public class Real2Array
extends Object
implements EuclidConstants, Iterable<Real2>
```
Real2Array is NOT a Vector of Real2s but a container for a 2 * n matrix with a variety of ways of managing the data including RealArrays for the x and y arrays, and also an array of Real2s The latter is only stored if required, and then is cached. Note that we also have Real2Vector which acts like a List(Real2). We may therefore obsolete the Real2Array at some time - it is not used in Jumbo elsewhere although it might be useful for spectra. NOTE: I think it's used quite a lot in fact...

Author:

P.Murray-Rust, Copyright 1997

Field Summary
- Fields inherited from interface org.xmlcml.euclid.EuclidConstants
  C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Constructor Summary

Constructors
Constructor and Description
`Real2Array()` default constructor gives an array of 0 points
`Real2Array(int size)` create with RealArrays of pre-allocated size.
`Real2Array(List<Real2> points)` create from list of points.
`Real2Array(Real2Array r2a)` copy
`Real2Array(RealArray x, RealArray y)` make an Real2_Array from 2 RealVec's; takes a copy

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Real2 r2)`
`void`	`add(Real2Array real2Array)`
`static Real2Array`	`createFromCoords(String coords)`
`static Real2Array`	`createFromPairs(RealArray ra)` make an Real2_Array from pairs of numbers x1,y1 ..
`static Real2Array`	`createFromPairs(String sss, String delimiter)` make an Real2_Array from pairs of numbers separated by delimiter
`Real2Array`	`createSubArray(int start)` create subArray starting at start inclusive
`Real2Array`	`createSubArray(int start, int end)` create subArray
`void`	`deleteElement(int i)` delete element.
`Real2`	`elementAt(int elem)` get element.
`Real2Array`	`format(int places)` round to decimal places.
`Real2`	`get(int elem)` get element.
`Real2`	`getLastElement()`
`Real2`	`getLastPoint()`
`List<Real2>`	`getList()`
`Real2`	`getMean()` gets unweighted mean of points.
`Real2Array`	`getMidPointArray(Real2Array real2Array)` gets average of two Real2Arrays.
`Real2`	`getPointWithMaximumX()`
`Real2`	`getPointWithMaximumY()`
`Real2`	`getPointWithMinimumX()`
`Real2`	`getPointWithMinimumY()`
`Real2Range`	`getRange2()` get max and min value of Real2_Array
`String`	`getStringArray()` to space-separated string.
`RealArray`	`getXArray()` extract X array.
`RealArray`	`getYArray()` extract Y array.
`boolean`	`isEqualTo(Real2Array r2b, double epsilon)` compares the arrays
`Iterator<Real2>`	`iterator()`
`void`	`reverse()` reverse direction of array MODIFIES THIS
`void`	`setElement(int elem, Real2 r2)` get element.
`int`	`size()` size of array.
`void`	`sortAscending(int xy)` sorts so that x0y0 has lowest x (0) or y (1)
`void`	`sortDescending(int xy)` sorts so that x0y0 has highest x (0) or y (1)
`Double`	`sumProductOfAllElements()`
`String`	`toString()` to string.
`void`	`transformBy(Transform2 t2)`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Real2Array
```
public Real2Array()
```
    default constructor gives an array of 0 points
  - Real2Array
```
public Real2Array(Real2Array r2a)
```
    copy
    
    Parameters:
    
    r2a -
  - Real2Array
```
public Real2Array(RealArray x,
                  RealArray y)
           throws EuclidRuntimeException
```
    make an Real2_Array from 2 RealVec's; takes a copy
    
    Parameters:
    
    x -
    
    y -
    
    Throws:
    
    EuclidRuntimeException - x and x must have number of elements
  - Real2Array
```
public Real2Array(int size)
```
    create with RealArrays of pre-allocated size.
    
    Parameters:
    
    size -
  - Real2Array
```
public Real2Array(List<Real2> points)
```
    create from list of points.
    
    Parameters:
    
    points -
- Method Detail
  - getRange2
```
public Real2Range getRange2()
```
    get max and min value of Real2_Array
    
    Returns:
    
    range
  - isEqualTo
```
public boolean isEqualTo(Real2Array r2b,
                         double epsilon)
```
    compares the arrays
    
    Parameters:
    
    r2b - array to compare to
    
    epsilon - tolerance in coordinates
    
    Returns:
    
    true if all points agree within epsilon
  - add
```
public void add(Real2 r2)
```
    Parameters:
    
    r2 -
  - add
```
public void add(Real2Array real2Array)
```
    Parameters:
    
    real2Array -
  - createFromPairs
```
public static Real2Array createFromPairs(String sss,
                                         String delimiter)
```
    make an Real2_Array from pairs of numbers separated by delimiter
    
    Parameters:
    
    sss -
    
    delimiter - (might be a regex e.g. ",| " (comma or space))
    
    Throws:
    
    EuclidRuntimeException - x and x must have number of elements
  - createFromPairs
```
public static Real2Array createFromPairs(RealArray ra)
```
    make an Real2_Array from pairs of numbers x1,y1 .. x2,y2 .. etc
    
    Parameters:
    
    ra -
    
    Throws:
    
    EuclidRuntimeException - x and x must have number of elements
  - getXArray
```
public RealArray getXArray()
```
    extract X array.
    
    Returns:
    
    array
  - getYArray
```
public RealArray getYArray()
```
    extract Y array.
    
    Returns:
    
    array
  - size
```
public int size()
```
    size of array.
    
    Returns:
    
    size
  - elementAt
```
public Real2 elementAt(int elem)
```
    get element.
    
    Parameters:
    
    elem -
    
    Returns:
    
    element
  - get
```
public Real2 get(int elem)
```
    get element.
    
    Parameters:
    
    elem -
    
    Returns:
    
    element
  - setElement
```
public void setElement(int elem,
                       Real2 r2)
```
    get element.
    
    Parameters:
    
    elem -
    
    r2 -
  - deleteElement
```
public void deleteElement(int i)
```
    delete element.
    
    Parameters:
    
    i -
  - transformBy
```
public void transformBy(Transform2 t2)
```
  - format
```
public Real2Array format(int places)
```
    round to decimal places.
    
    Parameters:
    
    places -
    
    Returns:
    
    this
  - getStringArray
```
public String getStringArray()
```
    to space-separated string.
    
    Returns:
    
    string
  - toString
```
public String toString()
```
    to string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - getLastElement
```
public Real2 getLastElement()
```
  - reverse
```
public void reverse()
```
    reverse direction of array MODIFIES THIS
  - sortAscending
```
public void sortAscending(int xy)
```
    sorts so that x0y0 has lowest x (0) or y (1)
    
    Parameters:
    
    xy - = 0 sort on x; xy = 1 sort on y
  - sortDescending
```
public void sortDescending(int xy)
```
    sorts so that x0y0 has highest x (0) or y (1)
    
    Parameters:
    
    xy - = 0 sort on x; xy = 1 sort on y
  - createSubArray
```
public Real2Array createSubArray(int start)
```
    create subArray starting at start inclusive
    
    Parameters:
    
    start -
    
    Returns:
  - createSubArray
```
public Real2Array createSubArray(int start,
                                 int end)
```
    create subArray
    
    Parameters:
    
    start - inclusive
    
    end - inclusive
    
    Returns:
  - createFromCoords
```
public static Real2Array createFromCoords(String coords)
```
  - getPointWithMinimumX
```
public Real2 getPointWithMinimumX()
```
  - getPointWithMaximumX
```
public Real2 getPointWithMaximumX()
```
  - getPointWithMinimumY
```
public Real2 getPointWithMinimumY()
```
  - getPointWithMaximumY
```
public Real2 getPointWithMaximumY()
```
  - getMidPointArray
```
public Real2Array getMidPointArray(Real2Array real2Array)
```
    gets average of two Real2Arrays.
    
    Parameters:
    
    real2Array -
    
    Returns:
    
    null if arrays are null or of different sizes
  - getMean
```
public Real2 getMean()
```
    gets unweighted mean of points.
    
    Returns:
    
    null if no points
  - iterator
```
public Iterator<Real2> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Real2>
  - sumProductOfAllElements
```
public Double sumProductOfAllElements()
```
  - getLastPoint
```
public Real2 getLastPoint()
```
  - getList
```
public List<Real2> getList()
```

Class Real2Array

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Real2Array

Real2Array

Real2Array

Real2Array

Real2Array

Method Detail

getRange2

isEqualTo

add

add

createFromPairs

createFromPairs

getXArray

getYArray

size

elementAt

get

setElement

deleteElement

transformBy

format

getStringArray

toString

getLastElement

reverse

sortAscending

sortDescending

createSubArray

createSubArray

createFromCoords

getPointWithMinimumX

getPointWithMaximumX

getPointWithMinimumY

getPointWithMaximumY

getMidPointArray

getMean

iterator

sumProductOfAllElements

getLastPoint

getList