vector.h

Go to the documentation of this file.

/*
    Sheep - A Rigid Body Dynamics Engine
    Copyright (C) 2001-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of Sheep.

    Sheep 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.

    Sheep is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Sheep; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef SHEEP_MATH_VECTOR_H
#define SHEEP_MATH_VECTOR_H

#include "common/misc/htmlstream.h"
#include "real.h"

#include <cassert>
#include <cmath>    // std::sqrt()

namespace sheep {

    class Vector {
    public:
        //! Constructors.
        Vector(int d);
        Vector(int d, Real r);
        Vector(const Vector &v);

        //! Destructor.
        virtual ~Vector();

        //! Assignment operators.
        Vector &operator=(Real r);
        Vector &operator=(const Vector &v);

        //! Vector dimension.
        int GetDimension() const;

        //! Basic operations.
        Vector operator+(const Vector &v) const;
        Vector operator-(const Vector &v) const;
        Vector operator-() const;
        Vector operator*(Real r) const;
        Vector operator/(Real r) const;
        Vector &operator+=(const Vector &v);
        Vector &operator-=(const Vector &v);
        Vector &operator*=(Real r);
        Vector &operator/=(Real r);

        //! Array subscripting.
        Real &operator[](int i);
        const Real &operator[](int i) const;

        //! Direct access to vector coefficients.
        Real *GetData();

        //! Square of the vector length.
        Real SquareNorm() const;

        //! Vector length.
        Real Norm() const;

        //! Normalized vector. Performance warning!
        Vector Normalized() const;

        //! Normalize the vector.
        void Normalize();

        //! Returns true if the vector is (approximately) unit-length.
        bool IsUnitLength(Real e = EPS) const;

    private:
        int m_d;    //!< Vector dimension.
        Real *m_v;  //!< Vector coefficients.
    };

    //! Product of a real by a vector.
    Vector operator*(Real r, const Vector &v);

    //! Deprecated.
    htmlstream& operator<<(htmlstream &s, const Vector &v);

#include "vector.inl"

}

#endif  // !SHEEP_MATH_VECTOR_H

---