point.h

Go to the documentation of this file.

/*
  Copyright (C) 2018 by the authors of the World Builder code.

  This file is part of the World Builder.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser 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 Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef _world_builder_point_h
#define _world_builder_point_h

#include <array>
#include <cmath>

#include <world_builder/coordinate_system.h>

namespace WorldBuilder
{
  template<int dim>
  class Point
  {
    public:
      Point();

      Point(const std::array<double,dim> &location, CoordinateSystem coordinate_system = CoordinateSystem::cartesian);

      Point(const Point<dim> &point, CoordinateSystem coordinate_system = CoordinateSystem::cartesian);

      Point(const double x, const double y, CoordinateSystem coordinate_system = CoordinateSystem::cartesian);

      Point(const double x, const double y, const double z, CoordinateSystem coordinate_system = CoordinateSystem::cartesian);

      ~Point();

      Point<dim> &operator=(const Point<dim> &point);

      double operator*(const Point<dim> &point) const;


      Point<dim> operator*(const double scalar) const;

      Point<dim> operator+(const Point<dim> &point) const;


      Point<dim> operator-(const Point<dim> &point) const;



      Point<dim> &operator*=(const double scalar);

      Point<dim> &operator+=(const Point<dim> &point);


      Point<dim> &operator-=(const Point<dim> &point);

      const double &operator[](const unsigned int index) const;


      double &operator[](const unsigned int index);


      const std::array<double,dim> &get_array() const;


      CoordinateSystem get_coordinate_system() const;


      double norm() const;


      double norm_square() const;


    private:
      std::array<double,dim> point;
      CoordinateSystem coordinate_system;

  };

  template<int dim>
  Point<dim> operator*(const double scalar, const Point<dim> &point);
}
#endif