///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program is distributed in the hope that it will be useful,           //
// but WITHOUT ANY WARRANTY; without even the implied warranty of            //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
// GNU General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////

package edu.cmu.tetrad.util;

import org.apache.commons.math3.util.FastMath;
import org.jetbrains.annotations.NotNull;

/**
 * Implements an n-dimensional point.
 *
 * @author josephramsey
 */
public class Point implements Comparable<Point> {

    /**
     * A vector representing the point coordinates.
     */
    private final Vector vector;

    /**
     * Constructs a point with coordinates as in the given vector.
     *
     * @param vector a vector representing the point coordinates, in order.
     */
    public Point(Vector vector) {
        this.vector = vector.copy();
    }

    /**
     * @param index Ibid.
     * @return Ibid.
     */
    public double getValue(int index) {
        return this.vector.get(index);
    }

    /**
     * @return Ibid.
     */
    public int getSize() {
        return this.vector.size();
    }

    /**
     * True iff the given object is a point with the same coordinates as
     * this one.
     *
     * @param p Ibid.
     * @return Ibid.
     */
    public int compareTo(@NotNull Point p) {
        if (p == this) {
            return 0;
        }

        for (int i = 0; i < getSize(); i++) {
            if (getValue(i) != p.getValue(i)) {
                return (int) FastMath.signum(p.getValue(i) - getValue(i));
            }
        }

        return 0;
    }

    /**
     * @return Ibid.
     */
    public String toString() {
        StringBuilder buf = new StringBuilder();

        buf.append("<");

        for (int i = 0; i < getSize(); i++) {
            buf.append(getValue(i));

            if (i < getSize() - 1) {
                buf.append(", ");
            }
        }

        buf.append(">");
        return buf.toString();
    }

    /**
     * @return Ibid.
     */
    public Vector getVector() {
        return this.vector.copy();
    }
}




