Point.h

/*
 *   Repast for High Performance Computing (Repast HPC)
 *
 *   Copyright (c) 2010 Argonne National Laboratory
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with
 *   or without modification, are permitted provided that the following
 *   conditions are met:
 *
 *     Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *     Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *     Neither the name of the Argonne National Laboratory nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 *  Point.h
 *
 *  Created on: Apr 1, 2010
 *      Author: nick
 */
 
#ifndef POINT_H_
#define POINT_H_
 
#include <vector>
#include <stdexcept>
#include <iostream>
#include <algorithm>
#include <math.h>
 
#include <boost/serialization/access.hpp>
#include <boost/functional/hash.hpp>
 
#include "RepastErrors.h"
 
namespace repast {
 
template<typename T>
class Point;
 
template<typename T>
struct HashGridPoint {
        std::size_t operator()(const Point<T>& pt) const {
                return pt.hash;
        }
};
 
template<typename T>
bool operator==(const Point<T> &one, const Point<T> &two);
 
template<typename T>
std::ostream& operator<<(std::ostream& os, const Point<T>& pt);
 
template<typename T>
class Point {
 
private:
        friend bool operator==<> (const Point<T> &one, const Point<T> &two);
        friend std::ostream& operator<<<> (std::ostream& os, const Point<T>& pt);
        friend struct HashGridPoint<T> ;
 
        void calcHash();
 
        std::vector<T> point;
        size_t hash;
 
        friend class boost::serialization::access;
 
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version) {
                ar & point;
                ar & hash;
        }
 
public:
 
        typedef typename std::vector<T>::const_iterator const_iterator;
 
        explicit Point(T x);
 
        Point(T x, T y);
 
        Point(T x, T y, T z);
 
        Point(std::vector<T> coordinates);
 
        T getX() const;
 
        T getY() const;
 
        T getZ() const;
 
        T getCoordinate(int coordIndex) const;
 
        void add(const Point<T> &pt);
 
        size_t dimensionCount() const {
                return point.size();
        }
 
        const T& operator[](size_t index) const {
                return point[index];
        }
 
        T& operator[](size_t index) {
                return point[index];
        }
 
        const std::vector<T>& coords() const {
                return point;
        }
 
        const_iterator begin() const {
                return point.begin();
        }
 
        const_iterator end() const {
                return point.end();
        }
 
        void copy(std::vector<T>& out) const;
};
 
template<typename T>
bool operator==(const Point<T> &one, const Point<T> &two);
template<typename T>
bool operator!=(const Point<T> &one, const Point<T> &two);
template<typename T>
std::ostream& operator<<(std::ostream& os, const Point<T>& pt);
 
template<typename T>
Point<T>::Point(T x) {
        point.push_back(x);
        calcHash();
}
 
template<typename T>
Point<T>::Point(T x, T y) {
        point.push_back(x);
        point.push_back(y);
        calcHash();
}
 
template<typename T>
Point<T>::Point(T x, T y, T z) {
        point.push_back(x);
        point.push_back(y);
        point.push_back(z);
        calcHash();
}
 
template<typename T>
Point<T>::Point(std::vector<T> coordinates) :
        point(coordinates.size(), 0) {
        std::copy(coordinates.begin(), coordinates.end(), point.begin());
        calcHash();
}
 
template<typename T>
void Point<T>::calcHash() {
        hash = 17;
        boost::hash<T> hasher;
        for (size_t i = 0; i < point.size(); i++) {
                hash = 37 * hash + hasher(point[i]);
        }
}
 
template<typename T>
T Point<T>::getX() const {
        return point.at(0);
}
 
template<typename T>
T Point<T>::getY() const {
        return point.at(1);
}
 
template<typename T>
T Point<T>::getZ() const {
        return point.at(2);
}
 
template<typename T>
T Point<T>::getCoordinate(int coordIndex) const {
        return point.at(coordIndex);
}
 
template<typename T>
void Point<T>::copy(std::vector<T>& out) const {
        std::copy(point.begin(), point.end(), out.begin());
}
 
template<typename T>
bool operator==(const Point<T> &one, const Point<T> &two) {
        return one.point == two.point;
}
 
template<typename T>
bool operator!=(const Point<T> &one, const Point<T> &two) {
        return !(one == two);
}
 
template<typename T>
void Point<T>::add(const Point<T> &pt) {
        if (pt.dimensionCount() != dimensionCount()) throw Repast_Error_35<Point<T> >(*this, pt); // Points do not have same number of dimensions
 
        for (size_t i = 0; i < point.size(); i++) {
                point[i] += pt.getCoordinate(i);
        }
}
 
template<typename T>
std::ostream& operator<<(std::ostream& os, const Point<T>& pt) {
        os << "Point[";
        for (size_t i = 0; i < pt.point.size(); i++) {
                if (i > 0)
                        os << ", ";
                os << pt.point[i];
        }
        os << "]";
        return os;
}
 
template<typename T>
bool operator<(const Point<T>& one, const Point<T>& two) {
        return std::lexicographical_compare(one.begin(), one.end(), two.begin(), two.end());
}
 
}
 
#endif /* POINT_H_ */