CepsVertex.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS 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 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include <Eigen/Dense>
#include <iomanip>
 
#include "common/core/CepsTypes.hpp"
 
class CepsVertex
{
public:
  CepsVertex (const CepsReal &x = 0.0, const CepsReal &y = 0.0, const CepsReal &z = 0.0);
 
  explicit CepsVertex (const CepsReal3D &coor);
 
  CepsVertex (const CepsVertex &) = default;
 
  CepsVertex (CepsVertex &&) noexcept = default;
 
  CepsVertex &
  operator= (const CepsVertex &) = default;
 
  CepsVertex &
  operator= (CepsVertex &&) noexcept = default;
 
  CepsVertex &
  operator= (const CepsMathVertices &vec);
 
  CepsVertex &
  operator= (const CepsReal3D &vec);
 
  virtual ~CepsVertex () = default;
 
  operator CepsMathVertex () const;
 
  // -------------------------------------------------------------------------
  // Coordinates manipulation
  // -------------------------------------------------------------------------
 
  void
  setX (const CepsReal &x);
 
  void
  setY (const CepsReal &y);
 
  void
  setZ (const CepsReal &z);
 
  void
  setCoordinate (const CepsUInt &dim, const CepsReal &coor);
 
  void
  setCoordinates (const CepsReal &x, const CepsReal &y = 0., const CepsReal &z = 0.);
 
  void
  setCoordinates (const CepsReal3D &coor);
 
  void
  setCoordinates (const CepsReal *coors, const CepsUInt &n);
 
  void
  scale (const CepsReal &scaleFactor);
 
  // -------------------------------------------------------------------------
  // Coordinates data
  // -------------------------------------------------------------------------
 
  const CepsReal &
  x () const;
 
  const CepsReal &
  y () const;
 
  const CepsReal &
  z () const;
 
  CepsReal &
  getCoordinate (const CepsSize &dim);
 
  const CepsReal &
  getCoordinate (const CepsSize &dim) const;
 
  CepsReal &
  operator[] (const CepsUInt &dim);
 
  const CepsReal &
  operator[] (const CepsUInt &dim) const;
 
  CepsReal3D &
  getCoordinates ();
 
  const CepsReal3D &
  getCoordinates () const;
 
  CepsMathVertex
  getCoordinatesForEigen () const;
 
  // -------------------------------------------------------------------------
  // Coordinates operations
  // -------------------------------------------------------------------------
 
  CepsBool
  equals (const CepsVertex &vert, const CepsReal &errorFactor = 1.0);
 
  CepsReal
  norm2 (const CepsSize &dim = 3) const;
 
  CepsReal
  normp (const CepsInt &p, const CepsSize &dim = 3) const;
 
  CepsReal
  dot (const CepsVertex &other, const CepsSize &dim = 3) const;
 
  friend std::ostream &
  operator<< (std::ostream &os, const CepsVertex &vertex);
 
private:
  CepsReal3D m_coor;
};
 
std::ostream &
operator<< (std::ostream &os, const CepsVertex &vertex);
 
CepsReal
dotProduct (const CepsVertex &a, const CepsVertex &b, const CepsSize &dim = 3);