KForm.h

 
#pragma once
 
#if defined(KForm_RECURSES)
#error Recursive header files inclusion detected in KForm.h
#else // defined(KForm_RECURSES)
#define KForm_RECURSES
 
#if !defined KForm_h
#define KForm_h
 
// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/base/Clone.h"
#include "DGtal/dec/Duality.h"
 
namespace DGtal
{
 
  // template class KForm
  template <typename TCalculus, Order order, Duality duality>
  class KForm
  {
    // ----------------------- Standard services ------------------------------
  public:
    typedef TCalculus Calculus;
 
    BOOST_STATIC_ASSERT(( order >= 0 ));
    BOOST_STATIC_ASSERT(( order <= Calculus::dimensionEmbedded ));
 
    typedef typename Calculus::DenseVector Container;
    typedef typename Calculus::Scalar Scalar;
    typedef typename Calculus::SCell SCell;
    typedef typename Calculus::Index Index;
 
    static
    KForm<TCalculus, order, duality>
    ones(ConstAlias<Calculus> calculus);
 
    static
    KForm<TCalculus, order, duality>
    zeros(ConstAlias<Calculus> calculus);
 
    static
    KForm<TCalculus, order, duality>
    dirac(ConstAlias<Calculus> calculus, const typename Calculus::Cell& cell);
 
    KForm(ConstAlias<Calculus> calculus);
 
    KForm(ConstAlias<Calculus> calculus, const Container& container);
 
    KForm& operator=(const KForm& other);
 
    // ----------------------- Interface --------------------------------------
  public:
 
    Container myContainer;
 
    const Calculus* myCalculus;
 
    void selfDisplay(std::ostream& out) const;
 
    std::string className() const;
 
    void clear();
 
    SCell getSCell(const Index& index) const;
 
    Index length() const;
 
    bool isValid() const;
 
    // ------------------------- Private Datas --------------------------------
  private:
 
    // ------------------------- Hidden services ------------------------------
  protected:
 
    KForm();
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class KForm
 
  template <typename Calculus, Order order, Duality duality>
  std::ostream&
  operator<<(std::ostream& out, const KForm<Calculus, order, duality>& object);
 
  template <typename Calculus, Order order, Duality duality>
  KForm<Calculus, order, duality>
  operator+(const KForm<Calculus, order, duality>& form_a, const KForm<Calculus, order, duality>& form_b);
 
  template <typename Calculus, Order order, Duality duality>
  KForm<Calculus, order, duality>
  operator-(const KForm<Calculus, order, duality>& form_a, const KForm<Calculus, order, duality>& form_b);
 
  template <typename Calculus, Order order, Duality duality>
  KForm<Calculus, order, duality>
  operator*(const typename Calculus::Scalar& scalar, const KForm<Calculus, order, duality>& form);
 
  template <typename Calculus, Order order, Duality duality>
  KForm<Calculus, order, duality>
  operator-(const KForm<Calculus, order, duality>& form);
 
} // namespace DGtal
 
 
// Includes inline functions.
#include "DGtal/dec/KForm.ih"
 
//                                                                           //
 
#endif // !defined KForm_h
 
#undef KForm_RECURSES
#endif // else defined(KForm_RECURSES)