Apache Commons Math 3.6.1 · org.apache.commons.math3.ml.clustering.DoublePoint

Modifier and Type	Field and Description
private final double[]	point Point coordinates.
private static final long	serialVersionUID Serializable version identifier.

Access	Constructor and Description
public	DoublePoint(final double[] the n-dimensional point in double space point) Build an instance wrapping an double array.
public	DoublePoint(final int[] the n-dimensional point in integer space point) Build an instance wrapping an integer array.

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public double[]	getPoint() Implements org.apache.commons.math3.ml.clustering.Clusterable.getPoint. Gets the n-dimensional point.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

point	back to summary
private final double[] point Point coordinates.

serialVersionUID	back to summary
private static final long serialVersionUID Serializable version identifier.

Constructor Detail

DoublePoint	back to summary
public DoublePoint(final double[] point) Build an instance wrapping an double array. The wrapped array is referenced, it is not copied. Parameters point:double[] the n-dimensional point in double space

DoublePoint

back to summary

public DoublePoint(final double[] point)

Build an instance wrapping an double array.

The wrapped array is referenced, it is not copied.

Parameters

point:double[]: the n-dimensional point in double space

DoublePoint	back to summary
public DoublePoint(final int[] point) Build an instance wrapping an integer array. The wrapped array is copied to an internal double array. Parameters point:int[] the n-dimensional point in integer space

DoublePoint

back to summary

public DoublePoint(final int[] point)

Build an instance wrapping an integer array.

The wrapped array is copied to an internal double array.

Parameters

point:int[]: the n-dimensional point in integer space

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getPoint	back to summary
public double[] getPoint() Implements org.apache.commons.math3.ml.clustering.Clusterable.getPoint. Doc from org.apache.commons.math3.ml.clustering.Clusterable.getPoint. Gets the n-dimensional point. Returns:double[] the point array

getPoint

back to summary

public double[] getPoint()

Implements org.apache.commons.math3.ml.clustering.Clusterable.getPoint.

Doc from org.apache.commons.math3.ml.clustering.Clusterable.getPoint.

Gets the n-dimensional point.

Returns:double[]: the point array

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class DoublePoint

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail