Stellarator-Tools
Loading...
Searching...
No Matches
gradient_descent::gradient_descent_test_class Interface Reference

Base class containing the parameters for the gradient_descent. More...

Inheritance diagram for gradient_descent::gradient_descent_test_class:
gradient_descent::gradient_descent_class

Public Member Functions

procedure chi2 (this, chi2)
 Compute the χ^2 value and the gradients.
 
class(gradient_descent_test_class) function, pointer gradient_descent_test_construct ()
 Construct a gradient_descent_test_class.
 
- Public Member Functions inherited from gradient_descent::gradient_descent_class
procedure chi2 (this, chi2)
 Compute the χ^2 value and the gradients.
 
procedure minimize (this)
 Gradient descent to minimize the χ^2 function.
 
FINAL gradient_descent_destruct (this)
 Deconstruct a gradient_descent_test_class object.
 

Additional Inherited Members

- Public Attributes inherited from gradient_descent::gradient_descent_class
real(rprec) step
 Step size to use.
 
real(rprec) tolarance
 Minimization tolarance.
 
real(rprec), dimension(:), pointer x_var => null()
 Variables.
 

Detailed Description

Base class containing the parameters for the gradient_descent.

Member Function/Subroutine Documentation

◆ chi2()

procedure gradient_descent::gradient_descent_test_class::chi2 ( class (gradient_descent_test_class), intent(in)  this,
real (rprec), dimension(:), intent(out)  chi2 
)

Compute the χ^2 value and the gradients.

This method should not be called directly and needs to be overloaded in a subclass.

Parameters
[in]thisA gradient_descent_context instance.
[out]chi2The χ^2 value and the gradients.

◆ gradient_descent_test_construct()

class (gradient_descent_test_class) function, pointer gradient_descent::gradient_descent_test_class::gradient_descent_test_construct

Construct a gradient_descent_test_class.

Allocates memory and initializes a gradient_descent_test_class object.

Returns
A pointer to a constructed gradient_descent_test_class object.

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