Jacobian Class Reference

#include <Jacobian.h>

Public Member Functions

 Jacobian (void)
 
 ~Jacobian (void)
 
void clear (void)
 zeroes all elements without resetting sparsity structure More...
 
void resize (unsigned int n)
 
unsigned int size () const
 
const double & elem (int i, int j) const
 
double setelem (int i, int j, double x)
 
void scaleelem (int i, int j, double y)
 if it exists, multiplies element i,j by y More...
 
bool nonzero (int i, int j) const
 
int nonzerocount (void) const
 
bool isSparse (void) const
 
void bmpout (const char *file_out_name) const
 
void printtripletmatrix (const char *filename) const
 
void print (void) const
 
double setcolumn (const std::vector< Value > &y_, int j, double scale)
 
int backslash (double *b)
 
int decompose (void)
 
int solve (double *b)
 
void release (void)
 release resources used for decomposing / solving More...
 

Detailed Description

dense / isSparse Jacobian

#include <libpf/core/Jacobian.h>

Remarks
Warning
Thread safe:
Extendable:
Platform dependencies:

Constructor & Destructor Documentation

◆ Jacobian()

Jacobian::Jacobian ( void  )

◆ ~Jacobian()

Jacobian::~Jacobian ( void  )

Member Function Documentation

◆ backslash()

int Jacobian::backslash ( double *  b)

invert matrix, solve with column vector x, put solution back into x returns 0 on success

◆ bmpout()

void Jacobian::bmpout ( const char *  file_out_name) const

output the Jacobian sparsity signature as a bitmap white = zero red = NAN light blues = absolute values between 1E-12 and 0 blue = absolute value smaller than 1E-12 light greens = absolute values between 0 and 1E12 blue = absolute value greater than 1E12

◆ clear()

void Jacobian::clear ( void  )

zeroes all elements without resetting sparsity structure

◆ decompose()

int Jacobian::decompose ( void  )

decompose Jacobian matrix returns 0 on success

◆ elem()

const double & Jacobian::elem ( int  i,
int  j 
) const

◆ isSparse()

bool Jacobian::isSparse ( void  ) const

◆ nonzero()

bool Jacobian::nonzero ( int  i,
int  j 
) const

◆ nonzerocount()

int Jacobian::nonzerocount ( void  ) const

◆ print()

void Jacobian::print ( void  ) const

◆ printtripletmatrix()

void Jacobian::printtripletmatrix ( const char *  filename) const

◆ release()

void Jacobian::release ( void  )

release resources used for decomposing / solving

◆ resize()

void Jacobian::resize ( unsigned int  n)

◆ scaleelem()

void Jacobian::scaleelem ( int  i,
int  j,
double  y 
)

if it exists, multiplies element i,j by y

◆ setcolumn()

double Jacobian::setcolumn ( const std::vector< Value > &  y_,
int  j,
double  scale 
)

◆ setelem()

double Jacobian::setelem ( int  i,
int  j,
double  x 
)

◆ size()

unsigned int Jacobian::size ( ) const
inline

◆ solve()

int Jacobian::solve ( double *  b)

solve already decomposed Jacobian with column vector x, put solution back into x returns 0 on success


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