Matrix.h

Go to the documentation of this file.

// %flair:license{
// This file is part of the Flair framework distributed under the
// CECILL-C License, Version 1.0.
// %flair:license}
#ifndef MATRIX_H
#define MATRIX_H

#include <io_data.h>
#include <IODataElement.h>
#include <cvmatrix_descriptor.h>

class Matrix_impl;

namespace flair {
namespace core {

class Matrix : public io_data {
public:
  class Type : public DataType {
  public:
    Type(size_t _nbRows, size_t _nbCols, ScalarType const &_elementDataType)
        : nbRows(_nbRows), nbCols(_nbCols), elementDataType(_elementDataType) {}
    size_t GetSize() const {
      return nbRows * nbCols * elementDataType.GetSize();
    }
    std::string GetDescription() const { return "matrix"; }
    size_t GetNbRows() const { return nbRows; }
    size_t GetNbCols() const { return nbCols; }
    ScalarType const &GetElementDataType() const { return elementDataType; }

  private:
    size_t nbRows, nbCols;
    ScalarType const &elementDataType;
  };

  Matrix(const Object *parent, const cvmatrix_descriptor *descriptor,
           ScalarType const &elementDataType, std::string name = "",
           uint32_t n = 1);

  Matrix(const Object *parent, uint32_t rows, uint32_t cols,
           ScalarType const &elementDataType, std::string name = "",
           uint32_t n = 1);

  ~Matrix();

  float Value(uint32_t row, uint32_t col) const;

  float ValueNoMutex(uint32_t row, uint32_t col) const;

  void SetValue(uint32_t row, uint32_t col, float value);

  void SetValueNoMutex(uint32_t row, uint32_t col, float value);

  std::string Name(uint32_t row, uint32_t col) const;

  IODataElement *Element(uint32_t row, uint32_t col) const;

  IODataElement *Element(uint32_t index) const;

  uint32_t Rows(void) const;

  uint32_t Cols(void) const;

  Type const &GetDataType() const { return dataType; };
  
  void RawRead(char *dst) const;

  void RawWrite(char *src);
  
private:
  class Matrix_impl *pimpl_;
  Type dataType;
};

} // end namespace core
} // end namespace flair

#endif // MATRIX_H