So-Bogus
A c++ sparse block matrix library aimed at Second Order cone problems
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
bogus::Zero< Scalar > Class Template Reference

Representation of the null matrix. More...

#include <Zero.hpp>

Inheritance diagram for bogus::Zero< Scalar >:
bogus::IterableBlockObject< Zero< Scalar > > bogus::BlockObjectBase< Derived >

Public Types

typedef IterableBlockObject
< Zero< Scalar > > 
Base
 
typedef Base::Index Index
 
typedef
Base::ConstTransposeReturnType 
ConstTransposeReturnType
 
typedef BlockMatrixTraits
< Zero< Scalar > > 
Traits
 
typedef Traits::Scalar Scalar
 
enum  { is_transposed = Traits::is_transposed }
 
enum  { RowsAtCompileTime = internal::DYNAMIC, ColsAtCompileTime = internal::DYNAMIC, is_self_transpose = Traits::is_symmetric }
 
typedef Traits::TransposeObjectType TransposeObjectType
 
typedef Traits::PlainObjectType PlainObjectType
 

Public Member Functions

 Zero (Index rows=0, Index cols=0)
 
Index rows () const
 
Index cols () const
 
Index blockRows (Index) const
 
Index blockCols (Index) const
 
Index rowsOfBlocks () const
 
Index colsOfBlocks () const
 
const Index * rowOffsets () const
 
const Index * colOffsets () const
 
ConstTransposeReturnType transpose () const
 
template<bool DoTranspose, typename RhsT , typename ResT >
void multiply (const RhsT &, ResT &res, Scalar=1, Scalar beta=0) const
 
Index size () const
 
template<typename Func >
void eachBlockOfRow (const Index, Func)
 
template<typename Func >
void eachBlockOfCol (const Index, Func)
 
template<bool DoTranspose, typename RhsT , typename ResT , typename PreOp >
void rowMultiplyPrecompose (const Index, const RhsT &, ResT &, const PreOp &) const
 
template<bool DoTranspose, typename RhsT , typename ResT , typename PostOp >
void colMultiplyPostcompose (const Index, const RhsT &, ResT &, const PostOp &) const
 
void rowMultiply (const Index row, const RhsT &rhs, ResT &res) const
 Multiplication with a single row.
 
void colMultiply (const Index col, const RhsT &rhs, ResT &res) const
 Multiplication with a single column.
 
void eachBlockOfRow (const Index row, Func func) const
 Iterates over each block of a given row. Calls func( col, block )
 
void eachBlockOfCol (const Index col, Func func) const
 Iterates over each block of a given col. Calls func( row, block )
 
const Derived & derived () const
 Returns a const reference to the implementation.
 
Derived & derived ()
 Returns a reference to the implementation.
 
Index rowOffset (Index row) const
 Returns an array containing the first index of a given row.
 
Index colOffset (Index col) const
 Returns an array containing the first index of a given columns.
 

Detailed Description

template<typename Scalar>
class bogus::Zero< Scalar >

Representation of the null matrix.

Useful as argument to functions expecting a BlockObjectBase


The documentation for this class was generated from the following file: