VectorField.h

 
#pragma once
 
#if defined(VectorField_RECURSES)
#error Recursive header files inclusion detected in VectorField.h
#else // defined(VectorField_RECURSES)
#define VectorField_RECURSES
 
#if !defined VectorField_h
#define VectorField_h
 
// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/dec/Duality.h"
#include "DGtal/dec/KForm.h"
#include "DGtal/kernel/PointVector.h"
 
namespace DGtal
{
 
  // template class VectorField
template <typename TCalculus, Duality duality>
  class VectorField
  {
    // ----------------------- Standard services ------------------------------
  public:
    typedef TCalculus Calculus;
 
    typedef typename Calculus::Scalar Scalar;
    typedef typename Calculus::SCell SCell;
    typedef typename Calculus::Index Index;
    typedef typename DGtal::PointVector<Calculus::dimensionAmbient, Scalar> Vector;
 
    typedef typename Calculus::DenseMatrix Coordinates;
    typedef Coordinates Container;
 
    VectorField(ConstAlias<Calculus> calculus);
 
    VectorField(ConstAlias<Calculus> calculus, const Container& container);
 
    VectorField& operator=(const VectorField& other);
 
    SCell getSCell(const Index& index) const;
 
    Index length() const;
 
    Vector getVector(const Index& index) const;
 
    void setVector(const Index& index, const Vector& vector);
 
    // ----------------------- Interface --------------------------------------
  public:
 
    Coordinates myCoordinates;
 
    const Calculus* myCalculus;
 
    void selfDisplay(std::ostream& out) const;
 
    std::string className() const;
 
    KForm<Calculus, 0, duality> coordAlongDirection(const Dimension& dir) const;
 
    KForm<Calculus, 0, duality> intensity(const typename Vector::NormType norm_type = Vector::L_2) const;
 
    void clear();
 
    VectorField<TCalculus, duality> normalized(const Scalar& epsilon = 0) const;
 
    bool isValid() const;
 
 
    // ------------------------- Private Datas --------------------------------
  private:
 
    // ------------------------- Hidden services ------------------------------
  protected:
 
    VectorField();
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class VectorField
 
 
  template <typename Calculus, Duality duality>
  std::ostream&
  operator<<(std::ostream& out, const VectorField<Calculus, duality>& object);
 
  template <typename Calculus, Duality duality>
  VectorField<Calculus, duality>
  operator+(const VectorField<Calculus, duality>& vector_field_a, const VectorField<Calculus, duality>& vector_field_b);
 
  template <typename Calculus, Duality duality>
  VectorField<Calculus, duality>
  operator-(const VectorField<Calculus, duality>& vector_field_a, const VectorField<Calculus, duality>& vector_field_b);
 
  template <typename Calculus, Duality duality>
  VectorField<Calculus, duality>
  operator*(const typename Calculus::Scalar& scalar, const VectorField<Calculus, duality>& vector_field);
 
  template <typename Calculus, Duality duality>
  VectorField<Calculus, duality>
  operator-(const VectorField<Calculus, duality>& vector_field);
 
} // namespace DGtal
 
 
// Includes inline functions.
#include "DGtal/dec/VectorField.ih"
 
//                                                                           //
 
#endif // !defined VectorField_h
 
#undef VectorField_RECURSES
#endif // else defined(VectorField_RECURSES)