Vector_.h

Go to the documentation of this file.

#ifndef SimTK_SIMMATRIX_VECTOR_H_
#define SimTK_SIMMATRIX_VECTOR_H_

/* -------------------------------------------------------------------------- *
 *                       Simbody(tm): SimTKcommon                             *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK biosimulation toolkit originating from           *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2005-13 Stanford University and the Authors.        *
 * Authors: Michael Sherman                                                   *
 * Contributors:                                                              *
 *                                                                            *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may    *
 * not use this file except in compliance with the License. You may obtain a  *
 * copy of the License at http://www.apache.org/licenses/LICENSE-2.0.         *
 *                                                                            *
 * Unless required by applicable law or agreed to in writing, software        *
 * distributed under the License is distributed on an "AS IS" BASIS,          *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
 * See the License for the specific language governing permissions and        *
 * limitations under the License.                                             *
 * -------------------------------------------------------------------------- */

namespace SimTK {

//==============================================================================
//                                 VECTOR
//==============================================================================
template <class ELT> class Vector_ : public VectorBase<ELT> {
    typedef typename CNT<ELT>::Scalar       S;
    typedef typename CNT<ELT>::Number       Number;
    typedef typename CNT<ELT>::StdNumber    StdNumber;
    typedef typename CNT<ELT>::TNeg         ENeg;
    typedef VectorBase<ELT>                 Base;
    typedef VectorBase<ENeg>                BaseNeg;
public:
    // Uses default destructor.

    Vector_() : Base() {}

    Vector_(const Vector_& src) : Base(src) {}

    Vector_(const Base& src) : Base(src) {}    // e.g., VectorView
    Vector_(const BaseNeg& src) : Base(src) {}

    explicit Vector_(int m) : Base(m) { }
    Vector_(int m, const ELT* cppInitialValues) : Base(m, cppInitialValues) {}
    Vector_(int m, const ELT& initialValue) : Base(m, initialValue) {}

    template <int M>
    explicit Vector_(const Vec<M,ELT>& v) : Base(M) {
        for (int i = 0; i < M; ++i)
            this->updElt(i, 0) = v(i);
    }
    Vector_(int m, const S* cppData, bool)
        : Base(m, Base::CppNScalarsPerElement, cppData) {}
    Vector_(int m, S* cppData, bool)
        : Base(m, Base::CppNScalarsPerElement, cppData) {}

    Vector_(int m, int stride, const S* data, bool)
        : Base(m, stride, data) {}
    Vector_(int m, int stride, S* data, bool)
        : Base(m, stride, data) {}
    Vector_& operator=(const Vector_& src)
    {   Base::operator=(src); return*this; }

    template <class EE> Vector_& operator=(const VectorBase<EE>& src)
    {   Base::operator=(src); return*this; }

    Vector_& operator=(const ELT& v) { Base::operator=(v); return *this; }

    template <class EE> Vector_& operator+=(const VectorBase<EE>& m)
    {   Base::operator+=(m); return*this; }
    template <class EE> Vector_& operator-=(const VectorBase<EE>& m)
    {   Base::operator-=(m); return*this; }

    Vector_& operator*=(const StdNumber& t) { Base::operator*=(t); return *this; }
    Vector_& operator/=(const StdNumber& t) { Base::operator/=(t); return *this; }

    Vector_& operator+=(const ELT& b) 
    {   this->elementwiseAddScalarInPlace(b); return *this; }
    Vector_& operator-=(const ELT& b) 
    {   this->elementwiseSubtractScalarInPlace(b); return *this; }
    std::string toString() const {
        std::stringstream stream;
        stream << (*this) ;
        return stream.str(); 
    }
    const ELT& get(int i) const { return (*this)[i]; }
    void set(int i, const ELT& value)  { (*this)[i]=value; }
private:
    // NO DATA MEMBERS ALLOWED
};

} //namespace SimTK

#endif // SimTK_SIMMATRIX_VECTOR_H_