All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
roboptim::detail::StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse > Struct Template Reference

SparseMatrix specialization of the getJacobianBlock() method provider. More...

#include <roboptim/core/detail/structured-input.hh>

Inheritance diagram for roboptim::detail::StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse >:
roboptim::detail::BlockProvider

Public Types

typedef
roboptim::GenericDifferentiableFunction
< typename FuncType::traits_t > 
differentiableFunction_t
 Differentiable function type. More...
 
typedef Eigen::Block< typename
differentiableFunction_t::jacobian_t,
Eigen::Dynamic, Eigen::Dynamic,
false > 
JacBlock
 return type of the getJacobianBlock() method More...
 
typedef
differentiableFunction_t::jacobian_ref 
InputJacBlock
 input type of the jacobian given by the user More...
 

Public Member Functions

JacBlock getJacobianBlock (InputJacBlock jacobian, size_t blockInd) const
 retrieve a specific block of the jacobian given as an input More...
 

Additional Inherited Members

- Public Attributes inherited from roboptim::detail::BlockProvider
std::vector< std::pair< size_t,
size_t > > 
blocks
 stores the blocks defined by the function as a pair of integers. More...
 

Detailed Description

template<typename FuncType>
struct roboptim::detail::StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse >

SparseMatrix specialization of the getJacobianBlock() method provider.

Member Typedef Documentation

Differentiable function type.

template<typename FuncType >
typedef differentiableFunction_t::jacobian_ref roboptim::detail::StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse >::InputJacBlock

input type of the jacobian given by the user

template<typename FuncType >
typedef Eigen::Block<typename differentiableFunction_t::jacobian_t, Eigen::Dynamic, Eigen::Dynamic, false> roboptim::detail::StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse >::JacBlock

return type of the getJacobianBlock() method

Member Function Documentation

template<typename FuncType >
StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse >::JacBlock roboptim::detail::StructuredInputJacobianInternal< FuncType, roboptim::EigenMatrixSparse >::getJacobianBlock ( InputJacBlock  jacobian,
size_t  blockInd 
) const

retrieve a specific block of the jacobian given as an input

Parameters
jacobianthe jacobian to operate upon
blockIndthe index of the block to be retrieved

References roboptim::detail::getBlock().