LinearOperator.h

#pragma once

#if defined(LinearOperator_RECURSES)
#error Recursive header files inclusion detected in LinearOperator.h
#else // defined(LinearOperator_RECURSES)

#define LinearOperator_RECURSES

#if !defined LinearOperator_h

#define LinearOperator_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/base/Clone.h"
#include "DGtal/dec/Duality.h"
#include "DGtal/dec/KForm.h"

namespace DGtal
{

  // template class LinearOperator
template <typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  class LinearOperator
  {
    // ----------------------- Standard services ------------------------------
  public:
    typedef TCalculus Calculus;

    BOOST_STATIC_ASSERT(( order_in >= 0 ));
    BOOST_STATIC_ASSERT(( order_in <= Calculus::dimensionEmbedded ));
    BOOST_STATIC_ASSERT(( order_out >= 0 ));
    BOOST_STATIC_ASSERT(( order_out <= Calculus::dimensionEmbedded ));

    typedef typename Calculus::SparseMatrix Container;
    typedef typename Calculus::Scalar Scalar;
    typedef KForm<Calculus, order_in, duality_in> InputKForm;
    typedef KForm<Calculus, order_out, duality_out> OutputKForm;
    typedef LinearOperator<Calculus, order_out, duality_out, order_in, duality_in> TransposedLinearOperator;


    LinearOperator(ConstAlias<Calculus> calculus);

    LinearOperator(ConstAlias<Calculus> calculus, const Container& container);

    LinearOperator& operator=(const LinearOperator& other);

    // ----------------------- Interface --------------------------------------
  public:

    Container myContainer;

    const Calculus* myCalculus;

    void selfDisplay(std::ostream& out) const;

    TransposedLinearOperator transpose() const;

    void clear();

    bool isValid() const;

    // ------------------------- Private Datas --------------------------------
  private:

    // ------------------------- Hidden services ------------------------------
  protected:

    LinearOperator();

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of class LinearOperator


  template <typename Calculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  std::ostream&
  operator<<(std::ostream& out,
             const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& object);

  template <typename Calculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>
  operator+(const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator_a,
            const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator_b);

  template <typename Calculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>
  operator-(const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator_a,
            const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator_b);

  template <typename Calculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>
  operator*(const typename Calculus::Scalar& scalar,
            const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator);

  template <typename Calculus, Order order_in, Duality duality_in, Order order_fold, Duality duality_fold, Order order_out, Duality duality_out>
  LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>
  operator*(const LinearOperator<Calculus, order_fold, duality_fold, order_out, duality_out>& operator_left,
            const LinearOperator<Calculus, order_in, duality_in, order_fold, duality_fold>& operator_right);

  template <typename Calculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  KForm<Calculus, order_out, duality_out>
  operator*(const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator,
            const KForm<Calculus, order_in, duality_in>& input_form);

  template <typename Calculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
  LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>
  operator-(const LinearOperator<Calculus, order_in, duality_in, order_out, duality_out>& linear_operator);

} // namespace DGtal


// Includes inline functions.
#include "DGtal/dec/LinearOperator.ih"

//                                                                           //

#endif // !defined LinearOperator_h

#undef LinearOperator_RECURSES
#endif // else defined(LinearOperator_RECURSES)