Module io.jenetics.jpx

Package io.jenetics.jpx

Class Degrees

java.lang.Object

java.lang.Number

io.jenetics.jpx.Degrees

All Implemented Interfaces:

Serializable, Comparable<Degrees>

public final class Degrees
extends Number
implements Comparable<Degrees>, Serializable

Used for bearing, heading, course. Base unit is decimal degree. Only values in the range of [0..360] are valid.

Since:

1.0

Version:

2.0

See Also:

• Value object
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final double	MAX_VALUE	A constant holding the maximum value a Degrees value can have, 360 inclusively.
static final double	MIN_VALUE	A constant holding the maximum value a Degrees value can have, 0 inclusively.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Degrees other)
double	doubleValue()	Return the decimal degree value.
boolean	equals(Object obj)
float	floatValue()
int	hashCode()
int	intValue()
long	longValue()
static Degrees	ofDegrees(double degrees)	Create a new Degrees object with the given decimal degree value.
static Degrees	ofRadians(double radians)	Create a new Degrees object with the given radians value.
double	toDegrees()	Return the decimal degree value.
double	toRadians()	Return the degrees in radians.
String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MIN_VALUE

public static final double MIN_VALUE

A constant holding the maximum value a Degrees value can have, 0 inclusively.

Since:

2.0

See Also:

• Constant Field Values

MAX_VALUE

public static final double MAX_VALUE

A constant holding the maximum value a Degrees value can have, 360 inclusively.

Since:

2.0

See Also:

• Constant Field Values

Method Details

doubleValue

public double doubleValue()

Return the decimal degree value.

Specified by:

doubleValue in class Number

Returns:

the decimal degree value

toRadians

public double toRadians()

Return the degrees in radians.

Returns:

the degrees in radians

toDegrees

public double toDegrees()

Return the decimal degree value.

Returns:

the decimal degree value

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

floatValue

public float floatValue()

Specified by:

floatValue in class Number

compareTo

public int compareTo(Degrees other)

Specified by:

compareTo in interface Comparable<Degrees>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

ofDegrees

public static Degrees ofDegrees(double degrees)

Create a new Degrees object with the given decimal degree value.

Parameters:

degrees - the decimal degree value

Returns:

a new Degrees object

Throws:

IllegalArgumentException - if the give value is not within the range of [0..360]

ofRadians

public static Degrees ofRadians(double radians)

Create a new Degrees object with the given radians value.

Parameters:

radians - the radians value

Returns:

a new Degrees object

Throws:

IllegalArgumentException - if the give value is not within the range of [0..2*Pi]