diff --git a/Euclidean.cpp b/Euclidean.cpp index 06352fa..5e83aec 100644 --- a/Euclidean.cpp +++ b/Euclidean.cpp @@ -1,9 +1,9 @@ #include "Euclidean.hpp" -double Euclidean::computeDistanceFrom(const Euclidean & euclidian) +double Euclidean::computeDistanceFrom(const Euclidean & euclidean) const { - double diffx = _x - euclidian.getX(); - double diffy = _y - euclidian.getY(); + double diffx = _x - euclidean.getX(); + double diffy = _y - euclidean.getY(); double diffx_sqr = pow(diffx, 2); double diffy_sqr = pow(diffy, 2); diff --git a/Euclidean.hpp b/Euclidean.hpp index 5b08d0a..32bffc0 100644 --- a/Euclidean.hpp +++ b/Euclidean.hpp @@ -4,31 +4,79 @@ #include #include +/** + * Euclidean class. + * + * @author William Durand + * @author Guillaume Bernard + */ class Euclidean { public: + /** + * Constructor + * + * @param const int x Coordinate X + * @param const int y Coordinate Y + */ Euclidean(const int x, const int y) : _x(x), _y(y) {} + /** + * @param const int x Coordinate X + */ void setX(const int x) { _x = x; } + /** + * @return const int + */ int getX() const { return _x; } + /** + * @param const int y Coordinate Y + */ void setY(const int y) { _y = y; } + /** + * @return const int + */ int getY() const { return _y; } + /** + * @param const double distance A distance. + */ void setDistance(const double distance) { _distance = distance; } + /** + * @return const double + */ double getDistance() const { return _distance; } + /** + * @param Euclidean & nearest + */ void setNearest(Euclidean & nearest) { _nearest = &nearest; } + /** + * @return const Euclidean* + */ Euclidean* getNearest() const { return _nearest; } - double computeDistanceFrom(const Euclidean & euclidian); + /** + * @param const Euclidean & euclidean + * @return const double + */ + double computeDistanceFrom(const Euclidean & euclidean) const; + /** + * @param const std::vector + * @return double + */ static double max(const std::vector vect); + /** + * @param const std::vector + * @return double + */ static double min(const std::vector vect); private: