10 #ifndef EIGEN_SPARSE_REF_H 11 #define EIGEN_SPARSE_REF_H 21 template<
typename Derived>
class SparseRefBase;
23 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int _Options,
typename _Str
ideType>
24 struct traits<Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, _Options, _StrideType> >
25 :
public traits<SparseMatrix<MatScalar,MatOptions,MatIndex> >
33 template<
typename Derived>
struct match {
35 StorageOrderMatch = PlainObjectType::IsVectorAtCompileTime || Derived::IsVectorAtCompileTime || ((PlainObjectType::Flags&
RowMajorBit)==(Derived::Flags&
RowMajorBit)),
38 typedef typename internal::conditional<MatchAtCompileTime,internal::true_type,internal::false_type>::type type;
43 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int _Options,
typename _Str
ideType>
44 struct traits<Ref<const SparseMatrix<MatScalar,MatOptions,MatIndex>, _Options, _StrideType> >
45 :
public traits<Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, _Options, _StrideType> >
52 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int _Options,
typename _Str
ideType>
53 struct traits<Ref<SparseVector<MatScalar,MatOptions,MatIndex>, _Options, _StrideType> >
54 :
public traits<SparseVector<MatScalar,MatOptions,MatIndex> >
62 template<
typename Derived>
struct match {
66 typedef typename internal::conditional<MatchAtCompileTime,internal::true_type,internal::false_type>::type type;
71 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int _Options,
typename _Str
ideType>
72 struct traits<Ref<const SparseVector<MatScalar,MatOptions,MatIndex>, _Options, _StrideType> >
73 :
public traits<Ref<SparseVector<MatScalar,MatOptions,MatIndex>, _Options, _StrideType> >
80 template<
typename Derived>
81 struct traits<SparseRefBase<Derived> > :
public traits<Derived> {};
83 template<
typename Derived>
class SparseRefBase
84 :
public SparseMapBase<Derived>
88 typedef SparseMapBase<Derived> Base;
89 EIGEN_SPARSE_PUBLIC_INTERFACE(SparseRefBase)
92 : Base(RowsAtCompileTime==
Dynamic?0:RowsAtCompileTime,ColsAtCompileTime==
Dynamic?0:ColsAtCompileTime, 0, 0, 0, 0, 0)
97 template<
typename Expression>
98 void construct(Expression& expr)
100 if(expr.outerIndexPtr()==0)
101 ::
new (static_cast<Base*>(
this)) Base(expr.size(), expr.nonZeros(), expr.innerIndexPtr(), expr.valuePtr());
103 ::new (static_cast<Base*>(
this)) Base(expr.rows(), expr.cols(), expr.nonZeros(), expr.outerIndexPtr(), expr.innerIndexPtr(), expr.valuePtr(), expr.innerNonZeroPtr());
121 #ifndef EIGEN_PARSED_BY_DOXYGEN 122 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
123 class Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType >
124 :
public internal::SparseRefBase<Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType > >
126 template<typename SparseMatrixType, int Options>
127 class
Ref<SparseMatrixType, Options>
128 :
public SparseMapBase<Derived,WriteAccessors>
132 typedef internal::traits<Ref> Traits;
133 template<
int OtherOptions>
135 template<
int OtherOptions>
139 typedef internal::SparseRefBase<Ref>
Base;
140 EIGEN_SPARSE_PUBLIC_INTERFACE(Ref)
143 #ifndef EIGEN_PARSED_BY_DOXYGEN 144 template<
int OtherOptions>
149 Base::construct(expr.
derived());
152 template<
int OtherOptions>
157 Base::construct(expr.derived());
160 template<
typename Derived>
164 template<
typename Derived>
168 EIGEN_STATIC_ASSERT(
bool(internal::is_lvalue<Derived>::value), THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY);
169 EIGEN_STATIC_ASSERT(
bool(Traits::template match<Derived>::MatchAtCompileTime), STORAGE_LAYOUT_DOES_NOT_MATCH);
171 Base::construct(expr.const_cast_derived());
176 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
177 class Ref<const SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType>
178 :
public internal::SparseRefBase<Ref<const SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> >
181 typedef internal::traits<Ref> Traits;
184 typedef internal::SparseRefBase<Ref> Base;
185 EIGEN_SPARSE_PUBLIC_INTERFACE(Ref)
187 template<
typename Derived>
190 construct(expr.
derived(),
typename Traits::template match<Derived>::type());
193 inline Ref(
const Ref& other) : Base(other), m_hasCopy(
false) {
197 template<
typename OtherRef>
198 inline Ref(
const RefBase<OtherRef>& other) : m_hasCopy(
false) {
199 construct(other.derived(),
typename Traits::template match<OtherRef>::type());
204 TPlainObjectType* obj =
reinterpret_cast<TPlainObjectType*
>(m_object_bytes);
205 obj->~TPlainObjectType();
211 template<
typename Expression>
212 void construct(
const Expression& expr,internal::true_type)
216 TPlainObjectType* obj =
reinterpret_cast<TPlainObjectType*
>(m_object_bytes);
217 ::new (obj) TPlainObjectType(expr);
219 Base::construct(*obj);
223 Base::construct(expr);
227 template<
typename Expression>
228 void construct(
const Expression& expr, internal::false_type)
230 TPlainObjectType* obj =
reinterpret_cast<TPlainObjectType*
>(m_object_bytes);
231 ::new (obj) TPlainObjectType(expr);
233 Base::construct(*obj);
237 char m_object_bytes[
sizeof(TPlainObjectType)];
252 #ifndef EIGEN_PARSED_BY_DOXYGEN 253 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
254 class Ref<SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType >
255 :
public internal::SparseRefBase<Ref<SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType > >
257 template<typename SparseVectorType>
258 class Ref<SparseVectorType>
259 :
public SparseMapBase<Derived,WriteAccessors>
263 typedef internal::traits<Ref> Traits;
264 template<
int OtherOptions>
268 typedef internal::SparseRefBase<Ref> Base;
269 EIGEN_SPARSE_PUBLIC_INTERFACE(Ref)
271 #ifndef EIGEN_PARSED_BY_DOXYGEN 272 template<
int OtherOptions>
276 Base::construct(expr.
derived());
279 template<
typename Derived>
283 template<
typename Derived>
287 EIGEN_STATIC_ASSERT(
bool(internal::is_lvalue<Derived>::value), THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY);
288 EIGEN_STATIC_ASSERT(
bool(Traits::template match<Derived>::MatchAtCompileTime), STORAGE_LAYOUT_DOES_NOT_MATCH);
289 Base::construct(expr.const_cast_derived());
294 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
295 class Ref<const SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType>
296 :
public internal::SparseRefBase<Ref<const SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> >
299 typedef internal::traits<Ref> Traits;
302 typedef internal::SparseRefBase<Ref> Base;
303 EIGEN_SPARSE_PUBLIC_INTERFACE(Ref)
305 template<
typename Derived>
308 construct(expr.
derived(),
typename Traits::template match<Derived>::type());
311 inline Ref(
const Ref& other) : Base(other), m_hasCopy(
false) {
315 template<
typename OtherRef>
316 inline Ref(
const RefBase<OtherRef>& other) : m_hasCopy(
false) {
317 construct(other.derived(),
typename Traits::template match<OtherRef>::type());
322 TPlainObjectType* obj =
reinterpret_cast<TPlainObjectType*
>(m_object_bytes);
323 obj->~TPlainObjectType();
329 template<
typename Expression>
330 void construct(
const Expression& expr,internal::true_type)
332 Base::construct(expr);
335 template<
typename Expression>
336 void construct(
const Expression& expr, internal::false_type)
338 TPlainObjectType* obj =
reinterpret_cast<TPlainObjectType*
>(m_object_bytes);
339 ::new (obj) TPlainObjectType(expr);
341 Base::construct(*obj);
345 char m_object_bytes[
sizeof(TPlainObjectType)];
353 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
354 struct evaluator<Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> >
355 : evaluator<SparseCompressedBase<Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> > >
357 typedef evaluator<SparseCompressedBase<Ref<SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> > > Base;
359 evaluator() : Base() {}
360 explicit evaluator(
const XprType &mat) : Base(mat) {}
363 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
364 struct evaluator<Ref<const SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> >
365 : evaluator<SparseCompressedBase<Ref<const SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> > >
367 typedef evaluator<SparseCompressedBase<Ref<const SparseMatrix<MatScalar,MatOptions,MatIndex>, Options, StrideType> > > Base;
369 evaluator() : Base() {}
370 explicit evaluator(
const XprType &mat) : Base(mat) {}
373 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
374 struct evaluator<Ref<SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> >
375 : evaluator<SparseCompressedBase<Ref<SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> > >
377 typedef evaluator<SparseCompressedBase<Ref<SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> > > Base;
379 evaluator() : Base() {}
380 explicit evaluator(
const XprType &mat) : Base(mat) {}
383 template<
typename MatScalar,
int MatOptions,
typename MatIndex,
int Options,
typename Str
ideType>
384 struct evaluator<Ref<const SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> >
385 : evaluator<SparseCompressedBase<Ref<const SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> > >
387 typedef evaluator<SparseCompressedBase<Ref<const SparseVector<MatScalar,MatOptions,MatIndex>, Options, StrideType> > > Base;
389 evaluator() : Base() {}
390 explicit evaluator(
const XprType &mat) : Base(mat) {}
397 #endif // EIGEN_SPARSE_REF_H bool isCompressed() const
Definition: SparseCompressedBase.h:107
const unsigned int CompressedAccessBit
Definition: Constants.h:186
A versatible sparse matrix representation.
Definition: SparseMatrix.h:96
Definition: SparseRef.h:16
const unsigned int LvalueBit
Definition: Constants.h:139
Namespace containing all symbols from the Eigen library.
Definition: Core:287
SparseMatrix< _Scalar, _Options, _StorageIndex > & derived()
Definition: EigenBase.h:45
const unsigned int RowMajorBit
Definition: Constants.h:61
Base class of any sparse matrices or sparse expressions.
Definition: ForwardDeclarations.h:281
a sparse vector class
Definition: SparseUtil.h:54
A matrix or vector expression mapping an existing expression.
Definition: Ref.h:190
Ref(SparseCompressedBase< Derived > &expr)
Definition: SparseRef.h:165
Definition: Eigen_Colamd.h:50
const int Dynamic
Definition: Constants.h:21
Common base class for sparse [compressed]-{row|column}-storage format.
Definition: SparseCompressedBase.h:15
Sparse matrix.
Definition: MappedSparseMatrix.h:32
Ref(SparseCompressedBase< Derived > &expr)
Definition: SparseRef.h:284