/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */ /* Author(s): Ofri Sadowsky, Anton Deguet Created on: 2004-07-01 (C) Copyright 2004-2018 Johns Hopkins University (JHU), All Rights Reserved. --- begin cisst license - do not edit --- This software is provided "as is" under an open source license, with no warranty. The complete license can be found in license.txt and http://www.cisst.org/cisst/license.txt. --- end cisst license --- */ #pragma once #ifndef _vctDynamicMatrixRef_h #define _vctDynamicMatrixRef_h /*! \file \brief Declaration of vctDynamicMatrixRef */ #include #include /*! \ingroup cisstVector \brief Dynamic matrix referencing existing memory The class vctDynamicMatrixRef allows to create a matrix overlaying an existing block of memory. It can be used to manipulate a container created by another toolkit (i.e. OpenGL, vtk, ...) or a cisstVector container using different parameters (different size, storage order or stride). To setup the overlay, one can use either the constructors or the SetRef methods. When used with a cisst container, the SetRef methods can infer some of the memory layout information (pointer on first element, sizes, strides). When used to overlay existing memory referenced by a pointer, the user has to provide all the required information. In any case, the Ref object doesn't allocate nor free memory. For example to manipulate the first five elements of a matrix, one can do: \code vctDynamicMatrix wholeMatrix(10, 10); vctRandom(wholeMatrix, -10.0, 10.0); vctDynamicMatrixRef first5x5; first5x5.SetRef(wholeMatrix, 0, 0, 5, 5); first5x5.SetAll(5.0); \endcode \note Make sure the underlying memory is not freed after the Ref object is created and before it is used. This would lead to faulty memory access and potential bugs. \note vctDynamicMatrixRef can perform const and non-const operations. It can be initialized with a non-const object only (value_type *). For a const Ref, see vctDynamicConstMatrixRef. \sa vctDynamicMatrix, vctDynamicConstMatrixRef \param _elementType Type of elements referenced. Also defined as value_type. */ template class vctDynamicMatrixRef: public vctDynamicMatrixBase, _elementType> { public: /* documented in base class */ VCT_CONTAINER_TRAITS_TYPEDEFS(_elementType); enum {DIMENSION = 2}; VCT_NARRAY_TRAITS_TYPEDEFS(DIMENSION); typedef vctDynamicMatrixRef<_elementType> ThisType; typedef vctDynamicMatrixRefOwner<_elementType> MatrixOwnerType; typedef vctDynamicMatrixBase, _elementType> BaseType; typedef typename MatrixOwnerType::iterator iterator; typedef typename MatrixOwnerType::const_iterator const_iterator; typedef typename MatrixOwnerType::reverse_iterator reverse_iterator; typedef typename MatrixOwnerType::const_reverse_iterator const_reverse_iterator; vctDynamicMatrixRef() { SetRef(0, 0, 1, 1, 0); } /*! Copy constructor. This copy constructor takes a const reference on the object to copy but has to remove the const-ness of the point to create a vctDynamicMatrixRef and allow it to manipulate elements. The explict use of a const_cast is far from great but there is no easy solution as C++ requires the copy constructor to take a const reference. */ vctDynamicMatrixRef(const ThisType & other): BaseType() { SetRef(other.sizes(), other.strides(), const_cast(other.Pointer())); } /*! Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element. */ //@{ vctDynamicMatrixRef(size_type rows, size_type cols, stride_type rowStride, stride_type colStride, pointer dataPointer) { SetRef(rows, cols, rowStride, colStride, dataPointer); } vctDynamicMatrixRef(const nsize_type & matrixSize, stride_type rowStride, stride_type colStride, pointer dataPointer) { SetRef(matrixSize, rowStride, colStride, dataPointer); } vctDynamicMatrixRef(const nsize_type & matrixSize, const nstride_type & matrixStride, pointer dataPointer) { SetRef(matrixSize, matrixStride, dataPointer); } //@} /*! Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major). */ //@{ vctDynamicMatrixRef(size_type rows, size_type cols, pointer dataPointer, bool storageOrder = VCT_DEFAULT_STORAGE) { SetRef(rows, cols, dataPointer, storageOrder); } vctDynamicMatrixRef(const nsize_type & matrixSize, pointer dataPointer, bool storageOrder = VCT_DEFAULT_STORAGE) { SetRef(matrixSize, dataPointer, storageOrder); } //@} /*! Construct a dynamic reference to a fixed-size matrix. \note the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors). */ template inline vctDynamicMatrixRef(vctFixedSizeMatrixBase<__rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType> & otherMatrix) { SetRef(otherMatrix); } /*! Construct a dynamic reference to a fixed-size matrix. \param otherMatrix a fixed size matrix to which a reference is created. \param startRow row index of the position where the reference will start. \param startCol column index of the position where the reference will start. \param rows the number of rows being referenced \param cols the number of columns being referenced \note the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors). */ template inline vctDynamicMatrixRef(vctFixedSizeMatrixBase<__rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType> & otherMatrix, size_type startRow, size_type startCol, size_type rows, size_type cols) { SetRef(otherMatrix, startRow, startCol, rows, cols); } /*! Construct a dynamic reference to a dynamic matrix. \note the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors). */ template inline vctDynamicMatrixRef(vctDynamicMatrixBase<__ownerType, _elementType> & otherMatrix) { SetRef(otherMatrix); } /*! Construct a dynamic reference to a submatrix of a dynamic matrix. \param otherMatrix a dynamic matrix to which a reference is created. \param startRow row index of the position where the reference will start. \param startCol column index of the position where the reference will start. \param rows the number of rows being referenced \param cols the number of columns being referenced \note the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors). */ //@ template inline vctDynamicMatrixRef(vctDynamicMatrixBase<__ownerType, _elementType> & otherMatrix, size_type startRow, size_type startCol, size_type rows, size_type cols) { SetRef(otherMatrix, startRow, startCol, rows, cols); } template inline vctDynamicMatrixRef(vctDynamicMatrixBase<__ownerType, _elementType> & otherMatrix, const nsize_type & start, const nsize_type & matrixSize) { SetRef(otherMatrix, start, matrixSize); } //@} /*! Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address. */ //@{ void SetRef(size_type rows, size_type cols, stride_type rowStride, stride_type colStride, pointer dataPointer) { this->Matrix.SetRef(rows, cols, rowStride, colStride, dataPointer); } void SetRef(const nsize_type & matrixSize, stride_type rowStride, stride_type colStride, pointer dataPointer) { this->Matrix.SetRef(matrixSize, rowStride, colStride, dataPointer); } void SetRef(const nsize_type & matrixSize, const nstride_type & matrixStride, pointer dataPointer) { this->Matrix.SetRef(matrixSize, matrixStride, dataPointer); } //@} /*! Set a dynamic reference to a memory location. The user should specify the dimension, start memory address and desired storage order. This method assumes there is enough memory and will create a compact matrix reference. */ //@{ void SetRef(size_type rows, size_type cols, pointer dataPointer, bool storageOrder = VCT_DEFAULT_STORAGE) { this->Matrix.SetRef(rows, cols, dataPointer, storageOrder); } void SetRef(const nsize_type & sizes, pointer dataPointer, bool storageOrder = VCT_DEFAULT_STORAGE) { this->Matrix.SetRef(sizes, dataPointer, storageOrder); } //@} /*! Set a dynamic reference to a fixed-size matrix. The reference will have identical dimensions and strides as the input matrix. */ template inline void SetRef(vctFixedSizeMatrixBase<__rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType> & otherMatrix) { SetRef(otherMatrix.rows(), otherMatrix.cols(), otherMatrix.row_stride(), otherMatrix.col_stride(), otherMatrix.Pointer()); } /*! Set a dynamic reference to a submatrix of a fixed-size matrix. \param otherMatrix a fixed size matrix to which a reference is created. \param startRow row index of the position where the reference will start. \param startCol column index of the position where the reference will start. \param rows the number of rows being referenced \param cols the number of columns being referenced \note the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the SetRef methods). \note This method verifies that the size of this matrix does not exceed the size of the input matrix (otherwise cmnThrow is used to throw std::out_of_range). */ template inline void SetRef(vctFixedSizeMatrixBase<__rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType> & otherMatrix, size_type startRow, size_type startCol, size_type rows, size_type cols) { if ( (startRow + rows > otherMatrix.rows()) || (startCol + cols > otherMatrix.cols()) ) { cmnThrow(std::out_of_range("vctDynamicMatrixRef SetRef out of range")); } SetRef(rows, cols, otherMatrix.row_stride(), otherMatrix.col_stride(), otherMatrix.Pointer(startRow, startCol)); } /*! Set a dynamic reference to a dynamic matrix. The reference will have identical dimensions and strides as the input matrix. */ template inline void SetRef(vctDynamicMatrixBase<__ownerType, _elementType> & otherMatrix) { SetRef(otherMatrix.rows(), otherMatrix.cols(), otherMatrix.row_stride(), otherMatrix.col_stride(), otherMatrix.Pointer()); } /*! Set a dynamic reference to a submatrix of a dynamic matrix. \param otherMatrix a dynamic matrix to which a reference is created. \param startRow row index of the position where the reference will start. \param startCol column index of the position where the reference will start. \param rows the number of rows being referenced \param cols the number of columns being referenced \note the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other SetRef methods). \note This method verifies that the size of this matrix does not exceed the size of the input matrix (otherwise cmnThrow is used to throw std::out_of_range). */ //@{ template inline void SetRef(vctDynamicMatrixBase<__ownerType, _elementType> & otherMatrix, size_type startRow, size_type startCol, size_type rows, size_type cols) { if ( (startRow + rows > otherMatrix.rows()) || (startCol + cols > otherMatrix.cols()) ) { cmnThrow(std::out_of_range("vctDynamicMatrixRef SetRef out of range")); } SetRef(rows, cols, otherMatrix.row_stride(), otherMatrix.col_stride(), otherMatrix.Pointer(startRow, startCol)); } template inline void SetRef(vctDynamicMatrixBase<__ownerType, _elementType> & otherMatrix, const nsize_type & start, const nsize_type & matrixSize) { SetRef(otherMatrix, start.Element(0), start.Element(1), matrixSize.Element(0), matrixSize.Element(1)); } //@} /*! \name Assignment operation into a matrix reference \param other The matrix to be copied. */ //@{ inline ThisType & operator = (const ThisType & other) { return reinterpret_cast(this->Assign(other)); } inline ThisType & operator = (const vctDynamicConstMatrixRef<_elementType> & other) { return reinterpret_cast(this->Assign(other)); } template inline ThisType & operator = (const vctDynamicConstMatrixBase<__matrixOwnerType, __elementType> & other) { return reinterpret_cast(this->Assign(other)); } template inline ThisType & operator = (const vctFixedSizeConstMatrixBase<__rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType> & other) { return reinterpret_cast(this->Assign(other)); } //@} /*! Assignement of a scalar to all elements. See also SetAll. */ inline ThisType & operator = (const value_type & value) { this->SetAll(value); return *this; } /*! Binary deserialization. This method can not resize the existing block of memory and will throw an exception is the sizes don't match. */ void DeSerializeRaw(std::istream & inputStream) CISST_THROW(std::runtime_error) { // get and set size size_type myRows; size_type myCols; cmnDeSerializeRaw(inputStream, myRows); cmnDeSerializeRaw(inputStream, myCols); if ((myRows != this->rows()) || (myCols != this->cols())) { cmnThrow(std::runtime_error("vctDynamicMatrixRef::DeSerializeRaw: Sizes of matrices don't match")); } // get data size_type indexRow, indexCol; for (indexRow = 0; indexRow < myRows; ++indexRow) { for (indexCol = 0; indexCol < myCols; ++indexCol) { cmnDeSerializeRaw(inputStream, this->Element(indexRow, indexCol)); } } } }; /* Methods declared and use for vctDynamicVectorBase. Implemented here since these need the const-matrix base. */ #ifndef DOXYGEN template inline void vctMultiplyMatrixVector(vctDynamicVectorBase<_resultVectorOwnerType, _elementType> & result, const vctDynamicConstMatrixBase<_matrixOwnerType, _elementType> & matrix, const vctDynamicConstVectorBase<_vectorOwnerType, _elementType> & vector) { const vctDynamicConstMatrixRef<_elementType> inputVectorRef(vector.size(), 1, vector.stride(), 1, vector.Pointer()); vctDynamicMatrixRef<_elementType> resultRef(result.size(), 1, result.stride(), 1, result.Pointer()); resultRef.ProductOf(matrix, inputVectorRef); } template inline void vctMultiplyVectorMatrix(vctDynamicVectorBase<_resultVectorOwnerType, _elementType> & result, const vctDynamicConstVectorBase<_vectorOwnerType, _elementType> & vector, const vctDynamicConstMatrixBase<_matrixOwnerType, _elementType> & matrix) { const vctDynamicConstMatrixRef<_elementType> inputVectorRef(1, vector.size() * vector.stride(), 1, vector.stride(), vector.Pointer()); vctDynamicMatrixRef<_elementType> resultRef(1, result.size() * result.stride(), 1, result.stride(), result.Pointer()); resultRef.ProductOf(inputVectorRef, matrix); } #endif // DOXYGEN #endif // _vctDynamicMatrixRef_h