org.xmlcml.euclid

Class Polar

java.lang.Object

org.xmlcml.euclid.Polar

All Implemented Interfaces:

EuclidConstants

public class Polar
extends Object
implements EuclidConstants

Polar coordinates (r, theta)

Author:

(C) P. Murray-Rust, 1996

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
Polar() constructor.
Polar(Complex c) constructor.
Polar(double a, Angle b) constructor.
Polar(double x, double y) constructor.
Polar(Polar a) constructor.

Method Summary

Modifier and Type	Method and Description
Polar	divideBy(Polar f) divide a polar by a polar
double	getR() gets radial part
Angle	getTheta() gets angular part
double	getX() get X, Y and XY coords
Real2	getXY() get coordinates.
double	getY() get y.
boolean	isEqualTo(Polar a) are two polar equal
Polar	multiplyBy(double f) multiply a polar by a scalar
Polar	multiplyBy(Polar f) multiply a polar by a polar
Polar	plus(Polar a2) add two polars
void	subtract() unary minus
Polar	subtract(Polar a2) subtract two polars
String	toString() to string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Polar

public Polar()

constructor.

Polar

public Polar(double x,
             double y)

constructor.

Parameters:

x -

y -

Polar

public Polar(double a,
             Angle b)

constructor.

Parameters:

a -

b -

Polar

public Polar(Complex c)

constructor.

Parameters:

c -

Polar

public Polar(Polar a)

constructor.

Parameters:

a -

Method Detail

getR

public double getR()

gets radial part

Returns:

radius

getTheta

public Angle getTheta()

gets angular part

Returns:

angle

plus

public Polar plus(Polar a2)

add two polars

Parameters:

a2 -

Returns:

new polar

subtract

public Polar subtract(Polar a2)

subtract two polars

Parameters:

a2 -

Returns:

new polar

subtract

public void subtract()

unary minus

multiplyBy

public Polar multiplyBy(Polar f)

multiply a polar by a polar

Parameters:

f -

Returns:

new polar

multiplyBy

public Polar multiplyBy(double f)

multiply a polar by a scalar

Parameters:

f -

Returns:

new polar

divideBy

public Polar divideBy(Polar f)
               throws EuclidRuntimeException

divide a polar by a polar

Parameters:

f -

Returns:

polar

Throws:

EuclidRuntimeException

isEqualTo

public boolean isEqualTo(Polar a)

are two polar equal

Parameters:

a -

Returns:

equals

getX

public double getX()

get X, Y and XY coords

Returns:

coord

getY

public double getY()

get y.

Returns:

coord

getXY

public Real2 getXY()

get coordinates.

Returns:

coordinates

toString

public String toString()

to string.

Overrides:

toString in class Object

Returns:

string