Functions
vnl_discrete_diff.h File Reference

Functions to compute jacobians of vnl_least_squares_functions. More...

#include <vnl/vnl_vector.h>
#include <vnl/vnl_matrix.h>
#include <vnl/algo/vnl_algo_export.h>

Go to the source code of this file.

Functions

bool VNL_ALGO_EXPORT vnl_discrete_diff_fwd (vnl_least_squares_function *lsf, double h, vnl_vector< double > const &x, vnl_matrix< double > &J)
 forward differences. More...
 
bool VNL_ALGO_EXPORT vnl_discrete_diff_fwd (vnl_least_squares_function *lsf, vnl_vector< double > const &h, vnl_vector< double > const &x, vnl_matrix< double > &J)
 forward differences. More...
 
bool VNL_ALGO_EXPORT vnl_discrete_diff_fwd (vnl_least_squares_function *lsf, vnl_vector< double > const &h, vnl_vector< double > const &x, vnl_vector< double > const &y, vnl_matrix< double > &J)
 forward differences. More...
 
bool VNL_ALGO_EXPORT vnl_discrete_diff_sym (vnl_least_squares_function *lsf, double h, vnl_vector< double > const &x, vnl_matrix< double > &J)
 symmetric differences. More...
 
bool VNL_ALGO_EXPORT vnl_discrete_diff_sym (vnl_least_squares_function *lsf, vnl_vector< double > const &h, vnl_vector< double > const &x, vnl_matrix< double > &J)
 symmetric differences. More...
 
void vnl_discrete_diff_test_lsf (vnl_least_squares_function *lsf, vnl_vector< double > const &x)
 

Detailed Description

Functions to compute jacobians of vnl_least_squares_functions.

Functions to compute jacobians of vnl_least_squares_functions by discrete differences. They return false on failure and true on success.

 name size    description

 lsf  ---     the function.
 h    1 or n  step size (scalar or a vector).
 x    n       point at which to evaluate the derivative of the function.
 y    m       value of the function at x.
 J    mxn     jacobian of the function at x.
Author
fsm
  Modifications
   dac (Manchester) 28/03/2001: tidied up documentation
   Peter Vanroose   27/05/2001: Corrected documentation

Definition in file vnl_discrete_diff.h.

Function Documentation

◆ vnl_discrete_diff_fwd() [1/3]

bool VNL_ALGO_EXPORT vnl_discrete_diff_fwd ( vnl_least_squares_function lsf,
double  h,
vnl_vector< double > const &  x,
vnl_matrix< double > &  J 
)

forward differences.

Definition at line 10 of file vnl_discrete_diff.cxx.

◆ vnl_discrete_diff_fwd() [2/3]

bool VNL_ALGO_EXPORT vnl_discrete_diff_fwd ( vnl_least_squares_function lsf,
vnl_vector< double > const &  h,
vnl_vector< double > const &  x,
vnl_matrix< double > &  J 
)

forward differences.

Definition at line 24 of file vnl_discrete_diff.cxx.

◆ vnl_discrete_diff_fwd() [3/3]

bool VNL_ALGO_EXPORT vnl_discrete_diff_fwd ( vnl_least_squares_function lsf,
vnl_vector< double > const &  h,
vnl_vector< double > const &  x,
vnl_vector< double > const &  y,
vnl_matrix< double > &  J 
)

forward differences.

Definition at line 36 of file vnl_discrete_diff.cxx.

◆ vnl_discrete_diff_sym() [1/2]

bool VNL_ALGO_EXPORT vnl_discrete_diff_sym ( vnl_least_squares_function lsf,
double  h,
vnl_vector< double > const &  x,
vnl_matrix< double > &  J 
)

symmetric differences.

Definition at line 64 of file vnl_discrete_diff.cxx.

◆ vnl_discrete_diff_sym() [2/2]

bool VNL_ALGO_EXPORT vnl_discrete_diff_sym ( vnl_least_squares_function lsf,
vnl_vector< double > const &  h,
vnl_vector< double > const &  x,
vnl_matrix< double > &  J 
)

symmetric differences.

Definition at line 74 of file vnl_discrete_diff.cxx.

◆ vnl_discrete_diff_test_lsf()

void vnl_discrete_diff_test_lsf ( vnl_least_squares_function lsf,
vnl_vector< double > const &  x 
)

Definition at line 108 of file vnl_discrete_diff.cxx.