mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-04-10 11:34:33 +08:00
884a718b0a
gives up enforcing constness. I really tried to enforce it, but it really was much hassle because our expression templates can be lvalues (not only rvalues) and so much code had to be written twice.
199 lines
7.1 KiB
C++
199 lines
7.1 KiB
C++
// This file is part of Eigen, a lightweight C++ template library
|
|
// for linear algebra. Eigen itself is part of the KDE project.
|
|
//
|
|
// Copyright (C) 2006-2007 Benoit Jacob <jacob@math.jussieu.fr>
|
|
//
|
|
// Eigen 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 or (at your option) any later version.
|
|
//
|
|
// Eigen 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 Eigen; if not, write to the Free Software Foundation, Inc., 51
|
|
// Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
//
|
|
// As a special exception, if other files instantiate templates or use macros
|
|
// or functions from this file, or you compile this file and link it
|
|
// with other works to produce a work based on this file, this file does not
|
|
// by itself cause the resulting work to be covered by the GNU General Public
|
|
// License. This exception does not invalidate any other reasons why a work
|
|
// based on this file might be covered by the GNU General Public License.
|
|
|
|
#ifndef EI_OBJECT_H
|
|
#define EI_OBJECT_H
|
|
|
|
template<typename Scalar, typename Derived> class Object
|
|
{
|
|
static const int RowsAtCompileTime = Derived::RowsAtCompileTime,
|
|
ColsAtCompileTime = Derived::ColsAtCompileTime;
|
|
|
|
template<typename OtherDerived>
|
|
void _copy_helper(const Object<Scalar, OtherDerived>& other);
|
|
|
|
template<typename OtherDerived>
|
|
bool _isApprox_helper(
|
|
const OtherDerived& other,
|
|
const typename NumTraits<Scalar>::Real& prec = NumTraits<Scalar>::precision()
|
|
) const;
|
|
bool _isMuchSmallerThan_helper(
|
|
const Scalar& other,
|
|
const typename NumTraits<Scalar>::Real& prec = NumTraits<Scalar>::precision()
|
|
) const;
|
|
template<typename OtherDerived>
|
|
bool _isMuchSmallerThan_helper(
|
|
const Object<Scalar, OtherDerived>& other,
|
|
const typename NumTraits<Scalar>::Real& prec = NumTraits<Scalar>::precision()
|
|
) const;
|
|
public:
|
|
static const int SizeAtCompileTime
|
|
= RowsAtCompileTime == Dynamic || ColsAtCompileTime == Dynamic
|
|
? Dynamic : RowsAtCompileTime * ColsAtCompileTime;
|
|
static const bool IsVector = RowsAtCompileTime == 1 || ColsAtCompileTime == 1;
|
|
|
|
typedef typename ForwardDecl<Derived>::Ref Ref;
|
|
typedef typename NumTraits<Scalar>::Real RealScalar;
|
|
|
|
int rows() const { return static_cast<const Derived *>(this)->_rows(); }
|
|
int cols() const { return static_cast<const Derived *>(this)->_cols(); }
|
|
int size() const { return rows() * cols(); }
|
|
|
|
Ref ref() const
|
|
{ return static_cast<const Derived *>(this)->_ref(); }
|
|
|
|
Scalar& write(int row, int col)
|
|
{
|
|
return static_cast<Derived *>(this)->_write(row, col);
|
|
}
|
|
|
|
Scalar read(int row, int col) const
|
|
{
|
|
return static_cast<const Derived *>(this)->_read(row, col);
|
|
}
|
|
|
|
template<typename OtherDerived>
|
|
Derived& operator=(const Object<Scalar, OtherDerived>& other)
|
|
{
|
|
assert(rows() == other.rows() && cols() == other.cols());
|
|
_copy_helper(other);
|
|
return *static_cast<Derived*>(this);
|
|
}
|
|
|
|
//special case of the above template operator=. Strangely, g++ 4.1 failed to use
|
|
//that template when OtherDerived == Derived
|
|
Derived& operator=(const Object& other)
|
|
{
|
|
assert(rows() == other.rows() && cols() == other.cols());
|
|
_copy_helper(other);
|
|
return *static_cast<Derived*>(this);
|
|
}
|
|
|
|
Row<Derived> row(int i) const;
|
|
Column<Derived> col(int i) const;
|
|
Minor<Derived> minor(int row, int col) const;
|
|
Block<Derived> block(int startRow, int endRow, int startCol, int endCol) const;
|
|
Transpose<Derived> transpose() const;
|
|
Conjugate<Derived> conjugate() const;
|
|
Transpose<Conjugate<Derived> > adjoint() const { return conjugate().transpose(); }
|
|
Scalar trace() const;
|
|
|
|
template<typename OtherDerived>
|
|
Scalar dot(const OtherDerived& other) const;
|
|
|
|
RealScalar norm2() const;
|
|
RealScalar norm() const;
|
|
ScalarMultiple<Derived> normalized() const;
|
|
|
|
static Eval<Random<Derived> >
|
|
random(int rows = RowsAtCompileTime, int cols = ColsAtCompileTime);
|
|
static Zero<Derived>
|
|
zero(int rows = RowsAtCompileTime, int cols = ColsAtCompileTime);
|
|
static Identity<Derived>
|
|
identity(int rows = RowsAtCompileTime);
|
|
static FromArray<Derived>
|
|
fromArray(const Scalar* array, int rows = RowsAtCompileTime, int cols = ColsAtCompileTime);
|
|
|
|
template<typename OtherDerived>
|
|
bool isApprox(
|
|
const OtherDerived& other,
|
|
const typename NumTraits<Scalar>::Real& prec = NumTraits<Scalar>::precision()
|
|
) const;
|
|
bool isMuchSmallerThan(
|
|
const Scalar& other,
|
|
const typename NumTraits<Scalar>::Real& prec = NumTraits<Scalar>::precision()
|
|
) const;
|
|
template<typename OtherDerived>
|
|
bool isMuchSmallerThan(
|
|
const Object<Scalar, OtherDerived>& other,
|
|
const typename NumTraits<Scalar>::Real& prec = NumTraits<Scalar>::precision()
|
|
) const;
|
|
|
|
template<typename OtherDerived>
|
|
Product<Derived, OtherDerived>
|
|
lazyProduct(const Object<Scalar, OtherDerived>& other) const EI_ALWAYS_INLINE;
|
|
|
|
Opposite<Derived> operator-() const;
|
|
|
|
template<typename OtherDerived>
|
|
Derived& operator+=(const Object<Scalar, OtherDerived>& other);
|
|
template<typename OtherDerived>
|
|
Derived& operator-=(const Object<Scalar, OtherDerived>& other);
|
|
template<typename OtherDerived>
|
|
Derived& operator*=(const Object<Scalar, OtherDerived>& other);
|
|
|
|
Derived& operator*=(const int& other);
|
|
Derived& operator*=(const float& other);
|
|
Derived& operator*=(const double& other);
|
|
Derived& operator*=(const std::complex<float>& other);
|
|
Derived& operator*=(const std::complex<double>& other);
|
|
|
|
Derived& operator/=(const int& other);
|
|
Derived& operator/=(const float& other);
|
|
Derived& operator/=(const double& other);
|
|
Derived& operator/=(const std::complex<float>& other);
|
|
Derived& operator/=(const std::complex<double>& other);
|
|
|
|
Scalar operator()(int row, int col) const
|
|
{ return read(row, col); }
|
|
|
|
Scalar& operator()(int row, int col)
|
|
{ return write(row, col); }
|
|
|
|
Scalar operator[](int index) const
|
|
{
|
|
assert(IsVector);
|
|
if(RowsAtCompileTime == 1) return read(0, index);
|
|
else return read(index, 0);
|
|
}
|
|
|
|
Scalar& operator[](int index)
|
|
{
|
|
assert(IsVector);
|
|
if(RowsAtCompileTime == 1) return write(0, index);
|
|
else return write(index, 0);
|
|
}
|
|
|
|
Eval<Derived> eval() const EI_ALWAYS_INLINE;
|
|
};
|
|
|
|
template<typename Scalar, typename Derived>
|
|
std::ostream & operator <<
|
|
( std::ostream & s,
|
|
const Object<Scalar, Derived> & m )
|
|
{
|
|
for( int i = 0; i < m.rows(); i++ )
|
|
{
|
|
s << m( i, 0 );
|
|
for (int j = 1; j < m.cols(); j++ )
|
|
s << " " << m( i, j );
|
|
if( i < m.rows() - 1)
|
|
s << std::endl;
|
|
}
|
|
return s;
|
|
}
|
|
|
|
#endif // EI_OBJECT_H
|