//                                               -*- C++ -*-
/**
 *  @brief TriangularComplexMatrix implements the classical mathematical triangular matrix with complex values
 *
 *  Copyright 2005-2018 Airbus-EDF-IMACS-Phimeca
 *
 *  This library 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  This library 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 library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef OPENTURNS_TRIANGULARCOMPLEXMATRIX_HXX
#define OPENTURNS_TRIANGULARCOMPLEXMATRIX_HXX

#include "openturns/SquareComplexMatrix.hxx"
#include "openturns/Collection.hxx"

BEGIN_NAMESPACE_OPENTURNS

class SymmetricMatrix;
class IdentityMatrix;
class SquareMatrix;
class Matrix;
class HermitianMatrix;

/**
 * @class TriangularComplexMatrix
 *
 * TriangularComplexMatrix implements the classical mathematical triangular matrix with complex values
 * Default implementation is triangular lower
 */

class OT_API TriangularComplexMatrix :
  public SquareComplexMatrix
{
  CLASSNAME

#ifndef SWIG
  friend TriangularComplexMatrix operator * (const Complex s,
      const TriangularComplexMatrix & m);
#endif

public:


  /** Default constructor */
  TriangularComplexMatrix();

  /** Constructor with size (dim, which is the same for nbRows_ and nbColumns_) */
  explicit TriangularComplexMatrix(const UnsignedInteger dimension,
                                   Bool isLower = true);

  /** Constructor with implementation */
  TriangularComplexMatrix(const Implementation & i,
                          const Bool isLower = true);

  /** String converter */
  String __repr__() const;
  String __str__(const String & offset = "") const;

  /** Get the dimension of the matrix */
  UnsignedInteger getDimension() const;

  /** TriangularComplexMatrix transpose */
  TriangularComplexMatrix transpose () const;

  /** TriangularComplexMatrix conjugate */
  TriangularComplexMatrix conjugate () const;

  /** TriangularComplexMatrix conjugate and transpose */
  TriangularComplexMatrix conjugateTranspose () const;

  /** Check if the matrix is lower or upper */
  Bool isLowerTriangular() const;

#ifndef SWIG
  /** Operator () gives access to the elements of the matrix (to modify these elements) */
  /** The element of the matrix is designated by its row number i and its column number j */
  Complex & operator () (const UnsignedInteger i,
                         const UnsignedInteger j) ;

  /** Operator () gives access to the elements of the matrix (read only) */
  /** The element of the matrix is designated by its row number i and its column number j */
  const Complex & operator () (const UnsignedInteger i,
                               const UnsignedInteger j) const;
#endif


  /** TriangularComplexMatrix additions : result is a complex matrix */
  SquareComplexMatrix operator + (const TriangularComplexMatrix & m) const;

  /** Addition operator with ComplexMatrix */
  SquareComplexMatrix operator + (const SquareComplexMatrix & m) const;

  /** Subtraction operator with TriangularComplexMatrix */
  SquareComplexMatrix operator - (const TriangularComplexMatrix & m) const;

  /** Subtraction operator with ComplexMatrix */
  SquareComplexMatrix operator - (const SquareComplexMatrix & m) const;

  /** Multiplication with a Complex */
  TriangularComplexMatrix operator * (const Complex s) const;

  /** ComplexMatrix multiplications */
  ComplexMatrix operator * (const ComplexMatrix & m) const;

  /** SquareComplexMatrix multiplications */
  SquareComplexMatrix operator * (const SquareComplexMatrix & m) const;

  /** TriangularComplexMatrix multiplications  */
  SquareComplexMatrix operator * (const TriangularComplexMatrix & m) const;

  /** HermitianMatrix multiplications  */
  SquareComplexMatrix operator * (const HermitianMatrix & m) const;

  /** Real SquareMatrix multiplications */
  SquareComplexMatrix operator * (const SquareMatrix & m) const;

  /** Real Matrix multiplications (must have consistent dimensions) */
  ComplexMatrix operator * (const Matrix & m) const;

  /** Real SymmetricMatrix multiplications  */
  SquareComplexMatrix operator * (const SymmetricMatrix & m) const;

  /** IdentityMatrix multiplications  */
  TriangularComplexMatrix operator * (const IdentityMatrix & m) const;

  /** Multiplication with a NumericaComplexCollection (must have consistent dimensions) */
  ComplexCollection operator * (const ComplexCollection & p) const;

  /** Multiplication with a NumericaScalarCollection (must have consistent dimensions) */
  ComplexCollection operator * (const ScalarCollection & p) const;

  /** Multiplication with a Point (must have consistent dimensions) */
  ComplexCollection operator * (const Point & p) const;

  /** Division by a Complex*/
  TriangularComplexMatrix operator / (const Complex s) const;

private:

  /** Boolean information : is the matrix triangular lower or upper? */
  mutable Bool isLowerTriangular_;

}; /* class TriangularComplexMatrix */


inline TriangularComplexMatrix operator * (const Complex s,
    const TriangularComplexMatrix & m)
{
  return m.operator * (s);
}


END_NAMESPACE_OPENTURNS

#endif /* OPENTURNS_TRIANGULARCOMPLEXMATRIX_HXX */
