itkVariableSizeMatrix.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkVariableSizeMatrix_h
#define itkVariableSizeMatrix_h
 
#include "itkPoint.h"
#include "itkCovariantVector.h"
#include "vnl/vnl_matrix_fixed.h"
#include "itkMathSVD.h"
#if !defined(ITK_LEGACY_REMOVE) && !defined(ITK_FUTURE_LEGACY_REMOVE)
#  include "vnl/algo/vnl_matrix_inverse.h" // transitional transitive include; dropped on ITK legacy removal
#endif
#include "vnl/vnl_transpose.h"
#include "vnl/vnl_matrix.h"
#include "itkArray.h"
#include "itkMath.h"
 
namespace itk
{
 
template <typename T>
class ITK_TEMPLATE_EXPORT VariableSizeMatrix
{
public:
  using Self = VariableSizeMatrix;

  using ValueType = T;
  using ComponentType = T;

  using InternalMatrixType = vnl_matrix<T>;

  Array<T>
  operator*(const Array<T> & vect) const;

  Self
  operator*(const Self & matrix) const;

  Self
  operator+(const Self & matrix) const;
 
  const Self &
  operator+=(const Self & matrix);

  Self
  operator-(const Self & matrix) const;
 
  const Self &
  operator-=(const Self & matrix);

  Self &
  operator-();

  vnl_matrix<T>
  operator*(const vnl_matrix<T> & matrix) const;

  void
  operator*=(const Self & matrix);

  void
  operator*=(const vnl_matrix<T> & matrix);

  vnl_vector<T>
  operator*(const vnl_vector<T> & vc) const;

  void
  operator*=(const T & value)
  {
    m_Matrix *= value;
  }

  Self
  operator*(const T & value) const
  {
    Self result(*this);
 
    result *= value;
    return result;
  }

  void
  operator/=(const T & value)
  {
    m_Matrix /= value;
  }

  Self
  operator/(const T & value) const
  {
    Self result(*this);
 
    result /= value;
    return result;
  }

  inline T &
  operator()(unsigned int row, unsigned int col)
  {
    return m_Matrix(row, col);
  }

  inline const T &
  operator()(unsigned int row, unsigned int col) const
  {
    return m_Matrix(row, col);
  }

  inline T *
  operator[](unsigned int i)
  {
    return m_Matrix[i];
  }

  inline const T *
  operator[](unsigned int i) const
  {
    return m_Matrix[i];
  }

  inline InternalMatrixType &
  GetVnlMatrix()
  {
    return m_Matrix;
  }

  [[nodiscard]] inline const InternalMatrixType &
  GetVnlMatrix() const
  {
    return m_Matrix;
  }

  inline void
  SetIdentity()
  {
    m_Matrix.set_identity();
  }

  inline void
  Fill(const T & value)
  {
    m_Matrix.fill(value);
  }

  inline Self &
  operator=(const vnl_matrix<T> & matrix)
  {
    m_Matrix = matrix;
    return *this;
  }

  inline bool
  operator==(const Self & matrix) const;
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);

  inline Self &
  operator=(const Self & matrix) = default;

  [[nodiscard]] inline vnl_matrix<T>
  GetInverse() const
  {
    return itk::Math::SVD(m_Matrix).PseudoInverse();
  }

  [[nodiscard]] inline vnl_matrix<T>
  GetTranspose() const
  {
    return m_Matrix.transpose();
  }

  VariableSizeMatrix()
    : m_Matrix()
  {}
 
  VariableSizeMatrix(unsigned int rows, unsigned int cols);

  VariableSizeMatrix(const Self & matrix)
    : m_Matrix(matrix.m_Matrix)
  {}

  [[nodiscard]] inline unsigned int
  Rows() const
  {
    return m_Matrix.rows();
  }

  [[nodiscard]] inline unsigned int
  Cols() const
  {
    return m_Matrix.cols();
  }

  inline bool
  SetSize(unsigned int r, unsigned int c)
  {
    return m_Matrix.set_size(r, c);
  }
 
private:
  InternalMatrixType m_Matrix;
};
 
template <typename T>
std::ostream &
operator<<(std::ostream & os, const VariableSizeMatrix<T> & v)
{
  os << v.GetVnlMatrix();
  return os;
}

template <typename T>
inline bool
VariableSizeMatrix<T>::operator==(const Self & matrix) const
{
  if ((matrix.Rows() != this->Rows()) || (matrix.Cols() != this->Cols()))
  {
    return false;
  }
  bool equal = true;
 
  for (unsigned int r = 0; r < this->Rows(); ++r)
  {
    for (unsigned int c = 0; c < this->Cols(); ++c)
    {
      if (Math::NotExactlyEquals(m_Matrix(r, c), matrix.m_Matrix(r, c)))
      {
        equal = false;
        break;
      }
    }
  }
  return equal;
}
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVariableSizeMatrix.hxx"
#endif
 
#endif