vpRowVector.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2017 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 http://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:
 * Operation on row vectors.
 *
 * Authors:
 * Eric Marchand
 *
 *****************************************************************************/

#ifndef vpRowVector_H
#define vpRowVector_H

#include <vector>

#include <visp3/core/vpArray2D.h>
#include <visp3/core/vpColVector.h>
#include <visp3/core/vpMath.h>
#include <visp3/core/vpMatrix.h>

class vpMatrix;
class vpColVector;

class VISP_EXPORT vpRowVector : public vpArray2D<double>
{
public:
  vpRowVector() : vpArray2D<double>() {}
  explicit vpRowVector(unsigned int n) : vpArray2D<double>(1, n) {}
  vpRowVector(unsigned int n, double val) : vpArray2D<double>(1, n, val) {}
  vpRowVector(const vpRowVector &v) : vpArray2D<double>(v) {}
  vpRowVector(const vpRowVector &v, unsigned int c, unsigned int ncols);
  vpRowVector(const vpMatrix &M);
  vpRowVector(const vpMatrix &M, unsigned int i);
  vpRowVector(const std::vector<double> &v);
  vpRowVector(const std::vector<float> &v);
  virtual ~vpRowVector() {}

  void clear()
  {
    if (data != NULL) {
      free(data);
      data = NULL;
    }

    if (rowPtrs != NULL) {
      free(rowPtrs);
      rowPtrs = NULL;
    }
    rowNum = colNum = dsize = 0;
  }

  std::ostream &cppPrint(std::ostream &os, const std::string &matrixName = "A", bool octet = false) const;
  std::ostream &csvPrint(std::ostream &os) const;

  inline void deg2rad()
  {
    double d2r = M_PI / 180.0;

    (*this) *= d2r;
  }

  double euclideanNorm() const;
  vpRowVector extract(unsigned int c, unsigned int rowsize) const
  {
    if (c >= colNum || c + rowsize > colNum) {
      throw(vpException(vpException::fatalError,
                        "Cannot extract a (1x%d) row vector from a (1x%d) "
                        "row vector starting at index %d",
                        rowsize, colNum, c));
    }

    return vpRowVector(*this, c, rowsize);
  }

  void init(const vpRowVector &v, unsigned int c, unsigned int ncols);
  void insert(unsigned int i, const vpRowVector &v);

  std::ostream &maplePrint(std::ostream &os) const;
  std::ostream &matlabPrint(std::ostream &os) const;

  vpRowVector &normalize();
  vpRowVector &normalize(vpRowVector &x) const;

  inline double &operator[](unsigned int n) { return *(data + n); }
  inline const double &operator[](unsigned int n) const { return *(data + n); }

  vpRowVector &operator=(const vpRowVector &v);
  vpRowVector &operator=(const vpMatrix &M);
  vpRowVector &operator=(const std::vector<double> &v);
  vpRowVector &operator=(const std::vector<float> &v);
  vpRowVector &operator=(const double x);

  double operator*(const vpColVector &x) const;
  vpRowVector operator*(const vpMatrix &M) const;
  vpRowVector operator*(const double x) const;
  vpRowVector &operator*=(double x);

  vpRowVector operator/(const double x) const;
  vpRowVector &operator/=(double x);

  vpRowVector operator+(const vpRowVector &v) const;
  vpRowVector &operator+=(vpRowVector v);

  vpRowVector operator-(const vpRowVector &v) const;
  vpRowVector &operator-=(vpRowVector v);
  vpRowVector operator-() const;

  vpRowVector &operator<<(const vpRowVector &v);

  int print(std::ostream &s, unsigned int length, char const *intro = 0) const;
  inline void rad2deg()
  {
    double r2d = 180.0 / M_PI;

    (*this) *= r2d;
  }
  void reshape(vpMatrix &M, const unsigned int &nrows, const unsigned int &ncols);
  vpMatrix reshape(const unsigned int &nrows, const unsigned int &ncols);

  inline void resize(const unsigned int i, const bool flagNullify = true)
  {
    vpArray2D<double>::resize(1, i, flagNullify);
  }

  void resize(const unsigned int nrows, const unsigned int ncols, const bool flagNullify)
  {
    if (nrows != 1)
      throw(vpException(vpException::fatalError,
                        "Cannot resize a row vector to a (%dx%d) dimension "
                        "vector that has more than one row",
                        nrows, ncols));
    vpArray2D<double>::resize(nrows, ncols, flagNullify);
  }

  void stack(const double &d);
  void stack(const vpRowVector &v);

  double sum() const;
  double sumSquare() const;
  vpColVector t() const;
  vpColVector transpose() const;
  void transpose(vpColVector &v) const;

  static double mean(const vpRowVector &v);
  static double median(const vpRowVector &v);
  static vpRowVector stack(const vpRowVector &A, const vpRowVector &B);
  static void stack(const vpRowVector &A, const vpRowVector &B, vpRowVector &C);
  static double stdev(const vpRowVector &v, const bool useBesselCorrection = false);

#if defined(VISP_BUILD_DEPRECATED_FUNCTIONS)

  vp_deprecated void init() {}
  vp_deprecated void stackMatrices(const vpRowVector &r) { stack(r); }
  vp_deprecated static vpRowVector stackMatrices(const vpRowVector &A, const vpRowVector &B) { return stack(A, B); }
  vp_deprecated static void stackMatrices(const vpRowVector &A, const vpRowVector &B, vpRowVector &C)
  {
    stack(A, B, C);
  }

  vp_deprecated void setIdentity(const double &val = 1.0);
#endif
};

VISP_EXPORT vpRowVector operator*(const double &x, const vpRowVector &v);

#endif