vpSubColVector.cpp

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Mask on a vpColVector.
 */
 
#include <stdlib.h>
 
#include <visp3/core/vpException.h>
#include <visp3/core/vpSubColVector.h>
 
BEGIN_VISP_NAMESPACE
vpSubColVector::vpSubColVector() : vpColVector(), m_pRowNum(0), m_parent(nullptr) { }

vpSubColVector::vpSubColVector(vpColVector &v, const unsigned int &offset, const unsigned int &nrows)
  : vpColVector(), m_pRowNum(0), m_parent(nullptr)
{
  init(v, offset, nrows);
}

void vpSubColVector::init(vpColVector &v, const unsigned int &offset, const unsigned int &nrows)
{
  if (!v.data) {
    throw(vpException(vpException::fatalError, "Cannot initialize a "
                      "sub-column vector from an "
                      "empty parent column vector"));
  }
 
  if ((offset + nrows) <= v.getRows()) {
    data = v.data + offset;
 
    rowNum = nrows;
    colNum = 1;
 
    m_pRowNum = v.getRows();
    m_parent = &v;
 
    if (rowPtrs) {
      free(rowPtrs);
    }
 
    rowPtrs = (double **)malloc(m_parent->getRows() * sizeof(double *));
    for (unsigned int i = 0; i < nrows; ++i) {
      rowPtrs[i] = v.data + (i + offset);
    }
 
    dsize = rowNum;
  }
  else {
    throw(vpException(vpException::dimensionError, "Cannot create a sub-column vector that is not "
                      "completely contained in the parent column vector"));
  }
}

vpSubColVector::~vpSubColVector() { data = nullptr; }

void vpSubColVector::checkParentStatus() const
{
  if (!data) {
    throw(vpException(vpException::fatalError, "The parent of the current sub-column vector has been destroyed"));
  }
  if (m_pRowNum != m_parent->getRows()) {
    throw(vpException(vpException::dimensionError, "The size of the parent sub-column vector has changed"));
  }
}

vpSubColVector &vpSubColVector::operator=(const vpSubColVector &B)
{
  if (rowNum != B.getRows()) {
    throw(vpException(vpException::dimensionError,
                      "Cannot initialize (%dx1) sub-column vector from "
                      "(%dx1) sub-column vector",
                      rowNum, B.getRows()));
  }
  m_pRowNum = B.m_pRowNum;
  for (unsigned int i = 0; i < rowNum; ++i) {
    data[i] = B[i];
  }
  return *this;
}

vpSubColVector &vpSubColVector::operator=(const vpColVector &B)
{
  if (rowNum != B.getRows()) {
    throw(vpException(vpException::dimensionError,
                      "Cannot initialize (%dx1) sub-column vector from "
                      "(%dx1) column vector",
                      rowNum, B.getRows()));
  }
 
  for (unsigned int i = 0; i < rowNum; ++i) {
    data[i] = B[i];
  }
 
  return *this;
}

vpSubColVector &vpSubColVector::operator=(const vpMatrix &B)
{
  if ((B.getCols() != 1) || (rowNum != B.getRows())) {
    throw(vpException(vpException::dimensionError, "Cannot initialize (%dx1) sub-column vector from (%dx%d) matrix",
                      rowNum, B.getRows(), B.getCols()));
  }
 
  for (unsigned int i = 0; i < rowNum; ++i) {
    data[i] = B[i][1];
  }
  return *this;
}

vpSubColVector &vpSubColVector::operator=(const double &x)
{
  for (unsigned int i = 0; i < rowNum; ++i) {
    data[i] = x;
  }
  return *this;
}

vpSubColVector &vpSubColVector::operator=(const vpTranslationVector &tv)
{
  unsigned int k = tv.getRows();
  if (rowNum != k) {
    try {
      resize(k);
    }
    catch (...) {
      throw;
    }
  }
 
  memcpy(data, tv.data, rowNum * sizeof(double));
  return *this;
}

vpSubColVector &vpSubColVector::operator=(const vpRotationVector &rv)
{
  unsigned int k = rv.getRows();
  if (rowNum != k) {
    try {
      resize(k);
    }
    catch (...) {
      throw;
    }
  }
 
  memcpy(data, rv.data, rowNum * sizeof(double));
  return *this;
}

vpSubColVector &vpSubColVector::operator=(const vpPoseVector &p)
{
  unsigned int k = p.getRows();
  if (rowNum != k) {
    try {
      resize(k);
    }
    catch (...) {
      throw;
    }
  }
 
  memcpy(data, p.data, rowNum * sizeof(double));
  return *this;
}
END_VISP_NAMESPACE