gradient_descent::gradient_descent_class Type Reference

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

Inheritance diagram for gradient_descent::gradient_descent_class:

Public Member Functions
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.

Public Attributes
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_class::chi2	(	class (gradient_descent_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]	this	A gradient_descent_context instance.
[out]	chi2	The χ^2 value and the gradients.

gradient_descent_destruct()

FINAL gradient_descent::gradient_descent_class::gradient_descent_destruct ( type (gradient_descent_class), intent(inout)  this )

final

Deconstruct a gradient_descent_test_class object.

Deallocates memory and uninitializes a gradient_descent_test_class object.

Parameters

[in,out]

this

A gradient_descent_test_class instance.

minimize()

procedure gradient_descent::gradient_descent_class::minimize

(

class (gradient_descent_class), intent(in)

this

)

Gradient descent to minimize the χ^2 function.

Parameters

[in,out]

this

A gradient_descent_context instance.

Returns

The χ^2 residule.

---

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

• LIBSTELL/Sources/Modules/gradient_descent.f