org.hipparchus.clustering.DoublePoint Maven / Gradle / Ivy
Show all versions of hipparchus-clustering Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* This is not the original file distributed by the Apache Software Foundation
* It has been modified by the Hipparchus project
*/
package org.hipparchus.clustering;
import java.io.Serializable;
import java.util.Arrays;
/**
* A simple implementation of {@link Clusterable} for points with double coordinates.
*/
public class DoublePoint implements Clusterable, Serializable {
/** Serializable version identifier. */
private static final long serialVersionUID = 3946024775784901369L;
/** Point coordinates. */
private final double[] point;
/**
* Build an instance wrapping an double array.
*
* The wrapped array is referenced, it is not copied.
*
* @param point the n-dimensional point in double space
*/
public DoublePoint(final double[] point) { // NOPMD - storage of array reference is intentional and documented here
this.point = point;
}
/**
* Build an instance wrapping an integer array.
*
* The wrapped array is copied to an internal double array.
*
* @param point the n-dimensional point in integer space
*/
public DoublePoint(final int[] point) {
this.point = new double[point.length];
for ( int i = 0; i < point.length; i++) {
this.point[i] = point[i];
}
}
/** {@inheritDoc}
*
* In this implementation of the {@link Clusterable} interface,
* the method always returns a reference to an internal array.
*
*/
@Override
public double[] getPoint() {
return point; // NOPMD - returning a reference to an internal array is documented here
}
/** {@inheritDoc} */
@Override
public boolean equals(final Object other) {
if (!(other instanceof DoublePoint)) {
return false;
}
return Arrays.equals(point, ((DoublePoint) other).point);
}
/** {@inheritDoc} */
@Override
public int hashCode() {
return Arrays.hashCode(point);
}
/** {@inheritDoc} */
@Override
public String toString() {
return Arrays.toString(point);
}
}