Module dedicated to the class tanhactivation. More...

Data Types
type	tanhactivation
	Implements a `tanh` activation function. More...

Functions/Subroutines
type(tanhactivation) function, public	construct_tanh_activation (self_size, batch_size)
	Constructor for class tanhactivation. More...

subroutine	tanh_tofile (self, unit_num)
	Implements tanhactivation::tofile. More...

subroutine	tanh_apply_forward (self, member, z, y)
	Implements tanhactivation::apply_forward. More...

Detailed Description

Module dedicated to the class tanhactivation.

Function/Subroutine Documentation

type(tanhactivation) function, public fnn_activation_tanh::construct_tanh_activation	(	integer(ik), intent(in)	self_size,
		integer(ik), intent(in)	batch_size
	)

Constructor for class tanhactivation.

Parameters

[in]	self_size	The value for linearactivation::self_size.
[in]	batch_size	The value for linearactivation::batch_size.

subroutine fnn_activation_tanh::tanh_apply_forward	(	class(tanhactivation), intent(inout)	self,
		integer(ik), intent(in)	member,
		real(rk), dimension(:), intent(in)	z,
		real(rk), dimension(:), intent(out)	y
	)

private

Applies and linearises the activation function.

The activation function reads

$\mathbf{y} = \mathcal{A}(\mathbf{z}) = \mathrm{tanh}(\mathbf{z}),$

and the associated linearisation reads

$\mathbf{A}(\mathbf{z}) = \mathrm{diag}(1-\mathrm{tanh}(\mathbf{z})^2).$

Note

Input parameter member should be less than linearactivation::batch_size.

The linarisation is stored in nonlinearactivation::z_prime, which is why the intent of self is declared inout.

Parameters

[in,out]	self	The activation function.
[in]	member	The index inside the batch.
[in]	z	The input of the activation function.
[out]	y	The output of the activation function.

subroutine fnn_activation_tanh::tanh_tofile	(	class(tanhactivation), intent(in)	self,
		integer(ik), intent(in)	unit_num
	)

private

Saves the activation function.

Parameters

[in]	self	The activation function to save.
[in]	unit_num	The unit number for the write statement.