Coord2d (Jzy3d API 1.0.0-SNAPSHOT API)

java.lang.Object
- org.jzy3d.maths.Coord2d

All Implemented Interfaces:

Serializable
```
public class Coord2d
extends Object
implements Serializable
```
A Coord2d stores a 2 dimensional coordinate for cartesian (x,y) or polar (a,r) mode, and provide operators allowing to add, substract, multiply and divises coordinate values, as well as computing the distance between two points, and converting polar and cartesian coordinates.

Author:

Martin Pernollet

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Coord2d`	`INVALID` An invalid Coord2d has value NaN for each dimension.
`static Coord2d`	`ORIGIN` The origin is a Coord2d having value 0 for each dimension.
`float`	`x`
`float`	`y`

Constructor Summary

Constructors
Constructor and Description
`Coord2d()` Creates a 2d coordinate with the value 0 for each dimension.
`Coord2d(double xi, double yi)` Creates a 2d coordinate.
`Coord2d(float xi, float yi)` Creates a 2d coordinate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Coord2d`	`add(Coord2d c2)` Add a Coord2d to the current one and return the result in a new Coord2d.
`Coord2d`	`add(float value)` Add a value to all components of the current Coord and return the result in a new Coord2d.
`Coord2d`	`add(float x, float y)`
`void`	`addSelf(Coord2d c2)`
`void`	`addSelf(float x, float y)`
`void`	`addSelfX(float x)`
`void`	`addSelfY(float y)`
`Coord2d`	`cartesian()` Converts the current Coord3d into cartesian coordinates and return the result in a new Coord3d.
`Coord2d`	`clone()` Return a duplicate of this 3d coordinate.
`double`	`distance(Coord2d c)` Compute the distance between two coordinates.
`double`	`distanceSq(Coord2d c)`
`Coord2d`	`div(Coord2d c2)` Divise a Coord2d to the current one and return the result in a new Coord2d.
`Coord2d`	`div(float value)` Divise all components of the current Coord by the same value and return the result in a new Coord3d.
`Coord2d`	`div(float x, float y)`
`void`	`divSelf(float value)`
`Coord2d`	`fullPolar()` Return a real polar value, with an angle in the range [0;2*PI] http://fr.wikipedia.org/wiki/Coordonn%C3%A9es_polaires
`float`	`getX()`
`float`	`getY()`
`Coord2d`	`interpolation(Coord2d c, float ratio)` Returns an interpolated point between the current and given point, according to an input ratio in [0;1] that indicates how near to the current point the new point will stand.
`Coord2d`	`mul(Coord2d c2)` Multiply a Coord2d to the current one and return the result in a new Coord2d.
`Coord2d`	`mul(float value)` Multiply all components of the current Coord and return the result in a new Coord3d.
`Coord2d`	`mul(float x, float y)`
`Coord2d`	`polar()` Converts the current `Coord2d` into polar coordinates and return the result in a new `Coord2d`.
`void`	`set(Coord2d c)`
`void`	`set(float x, float y)`
`Coord2d`	`sub(Coord2d c2)` Substract a Coord2d to the current one and return the result in a new Coord2d.
`Coord2d`	`sub(float value)` Substract a value to all components of the current Coord and return the result in a new Coord2d.
`Coord2d`	`sub(float x, float y)`
`float[]`	`toArray()` Return an array representation of this coordinate.
`String`	`toString()` Return a string representation of this coordinate.

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

- Field Detail
  - ORIGIN
```
public static final Coord2d ORIGIN
```
    The origin is a Coord2d having value 0 for each dimension.
  - INVALID
```
public static final Coord2d INVALID
```
    An invalid Coord2d has value NaN for each dimension.
  - x
```
public float x
```
  - y
```
public float y
```
- Constructor Detail
  - Coord2d
```
public Coord2d()
```
    Creates a 2d coordinate with the value 0 for each dimension.
  - Coord2d
```
public Coord2d(float xi,
               float yi)
```
    Creates a 2d coordinate. When using polar mode, x represents angle, and y represents distance.
  - Coord2d
```
public Coord2d(double xi,
               double yi)
```
    Creates a 2d coordinate. When using polar mode, x represents angle, and y represents distance.
- Method Detail
  - clone
```
public Coord2d clone()
```
    Return a duplicate of this 3d coordinate.
    
    Overrides:
    
    clone in class Object
  - set
```
public void set(Coord2d c)
```
  - set
```
public void set(float x,
                float y)
```
  - add
```
public Coord2d add(Coord2d c2)
```
    Add a Coord2d to the current one and return the result in a new Coord2d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord2d
  - addSelf
```
public void addSelf(Coord2d c2)
```
  - addSelf
```
public void addSelf(float x,
                    float y)
```
  - addSelfX
```
public void addSelfX(float x)
```
  - addSelfY
```
public void addSelfY(float y)
```
  - add
```
public Coord2d add(float value)
```
    Add a value to all components of the current Coord and return the result in a new Coord2d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord2d
  - add
```
public Coord2d add(float x,
                   float y)
```
  - sub
```
public Coord2d sub(Coord2d c2)
```
    Substract a Coord2d to the current one and return the result in a new Coord2d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord2d
  - sub
```
public Coord2d sub(float value)
```
    Substract a value to all components of the current Coord and return the result in a new Coord2d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord2d
  - sub
```
public Coord2d sub(float x,
                   float y)
```
  - mul
```
public Coord2d mul(Coord2d c2)
```
    Multiply a Coord2d to the current one and return the result in a new Coord2d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord2d
  - mul
```
public Coord2d mul(float x,
                   float y)
```
  - mul
```
public Coord2d mul(float value)
```
    Multiply all components of the current Coord and return the result in a new Coord3d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord3d
  - div
```
public Coord2d div(Coord2d c2)
```
    Divise a Coord2d to the current one and return the result in a new Coord2d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord2d
  - div
```
public Coord2d div(float value)
```
    Divise all components of the current Coord by the same value and return the result in a new Coord3d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord3d
  - div
```
public Coord2d div(float x,
                   float y)
```
  - divSelf
```
public void divSelf(float value)
```
  - cartesian
```
public Coord2d cartesian()
```
    Converts the current Coord3d into cartesian coordinates and return the result in a new Coord3d.
    
    Returns:
    
    the result Coord3d
  - polar
```
public Coord2d polar()
```
    Converts the current Coord2d into polar coordinates and return the result in a new Coord2d.
  - fullPolar
```
public Coord2d fullPolar()
```
    Return a real polar value, with an angle in the range [0;2*PI] http://fr.wikipedia.org/wiki/Coordonn%C3%A9es_polaires
  - distance
```
public double distance(Coord2d c)
```
    Compute the distance between two coordinates.
  - distanceSq
```
public double distanceSq(Coord2d c)
```
  - interpolation
```
public Coord2d interpolation(Coord2d c,
                             float ratio)
```
    Returns an interpolated point between the current and given point, according to an input ratio in [0;1] that indicates how near to the current point the new point will stand. A value of 1 will return a copy of the current point.
  - toString
```
public String toString()
```
    Return a string representation of this coordinate.
    
    Overrides:
    
    toString in class Object
  - toArray
```
public float[] toArray()
```
    Return an array representation of this coordinate.
  - getX
```
public float getX()
```
  - getY
```
public float getY()
```

Class Coord2d

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORIGIN

INVALID

x

y

Constructor Detail

Coord2d

Coord2d

Coord2d

Method Detail

clone

set

set

add

addSelf

addSelf

addSelfX

addSelfY

add

add

sub

sub

sub

mul

mul

mul

div

div

div

divSelf

cartesian

polar

fullPolar

distance

distanceSq

interpolation

toString

toArray

getX

getY