athena_activation_gaussian.f90 Source File


Source Code

module athena__activation_gaussian
  !! Module containing implementation of the Gaussian activation function
  !!
  !! This module implements the Gaussian (bell curve) activation,
  !! which produces maximum activation at the origin.
  !!
  !! Mathematical operation:
  !! \[ f(x) = \frac{1}{\sqrt{2\pi\sigma^2}} \exp\left(-\frac{(x-\mu)^2}{2\sigma^2}\right) \]
  !!
  !! Derivative:
  !! \[ f'(x) = -\frac{x-\mu}{\sigma^3\sqrt{2\pi}} \exp\left(-\frac{(x-\mu)^2}{2\sigma^2}\right) \]
  !!
  !! Properties: Smooth, symmetric, max at \(x=\mu\)
  !! Used in Radial Basis Function (RBF) networks
  !! Responds strongly to inputs near \(\mu\)
  use coreutils, only: real32, print_warning
  use diffstruc, only: array_type, gaussian, operator(*)
  use athena__misc_types, only: base_actv_type
  use athena__misc_types, only: onnx_attribute_type
  implicit none


  private

  public :: gaussian_actv_type, create_from_onnx_gaussian_activation


  type, extends(base_actv_type) :: gaussian_actv_type
     !! Type for Gaussian activation function with overloaded procedures
     real(real32) :: sigma
     !! Standard deviation parameter for Gaussian function
     real(real32) :: mu
     !! Mean parameter for Gaussian function
   contains
     procedure, pass(this) :: apply => apply_gaussian
     procedure, pass(this) :: reset => reset_gaussian
     procedure, pass(this) :: apply_attributes => apply_attributes_gaussian
     procedure, pass(this) :: export_attributes => export_attributes_gaussian
  end type gaussian_actv_type

  interface gaussian_actv_type
     procedure initialise
  end interface gaussian_actv_type



contains

!###############################################################################
  function initialise(scale, sigma, mu, attributes) result(activation)
    !! Initialise a Gaussian activation function
    implicit none

    ! Arguments
    real(real32), intent(in), optional :: scale
    !! Optional scale factor for activation output
    real(real32), intent(in), optional :: sigma
    !! Optional standard deviation parameter
    real(real32), intent(in), optional :: mu
    !! Optional mean parameter
    type(onnx_attribute_type), dimension(:), intent(in), optional :: attributes
    !! Optional array of ONNX attributes
    type(gaussian_actv_type) :: activation
    !! Gaussian activation type


    call activation%reset()

    if(present(scale)) activation%scale = scale
    if(abs(activation%scale-1._real32) .gt. 1.e-6_real32)then
       activation%apply_scaling = .true.
    end if

    if(present(sigma)) activation%sigma = sigma
    if(present(mu)) activation%mu = mu

    if(present(attributes))then
       call activation%apply_attributes(attributes)
    end if

  end function initialise
!-------------------------------------------------------------------------------
  pure subroutine reset_gaussian(this)
    !! Reset Gaussian activation function attributes and variables
    implicit none

    ! Arguments
    class(gaussian_actv_type), intent(inout) :: this
    !! Gaussian activation type

    this%name = "gaussian"
    this%scale = 1._real32
    this%threshold = 0._real32
    this%apply_scaling = .false.
    this%sigma = 1.5_real32
    this%mu = 0._real32

  end subroutine reset_gaussian
!-------------------------------------------------------------------------------
  function create_from_onnx_gaussian_activation(attributes) result(activation)
    !! Create Gaussian activation function from ONNX attributes
    implicit none

    ! Arguments
    type(onnx_attribute_type), dimension(:), intent(in) :: attributes
    !! Array of ONNX attributes

    class(base_actv_type), allocatable :: activation
    !! Instance of activation type

    allocate(activation, source = gaussian_actv_type(attributes = attributes))

  end function create_from_onnx_gaussian_activation
!###############################################################################


!###############################################################################
  subroutine apply_attributes_gaussian(this, attributes)
    !! Load ONNX attributes into Gaussian activation function
    implicit none

    ! Arguments
    class(gaussian_actv_type), intent(inout) :: this
    !! Gaussian activation type
    type(onnx_attribute_type), dimension(:), intent(in) :: attributes
    !! Array of ONNX attributes

    ! Local variables
    integer :: i
    !! Loop variable

    ! Load provided attributes
    do i=1, size(attributes,dim=1)
       select case(trim(attributes(i)%name))
       case("scale")
          read(attributes(i)%val,*) this%scale
          if(abs(this%scale-1._real32) .gt. 1.e-6_real32)then
             this%apply_scaling = .true.
          else
             this%apply_scaling = .false.
          end if
       case("sigma")
          read(attributes(i)%val,*) this%sigma
       case("mu")
          read(attributes(i)%val,*) this%mu
       case("name")
          if(trim(attributes(i)%val) .ne. trim(this%name))then
             call print_warning( &
                  'Gaussian activation: name attribute "' // &
                  trim(attributes(i)%val) // &
                  '"" does not match expected "' // trim(this%name)//'"' &
             )

          end if
       case default
          call print_warning( &
               'Gaussian activation: unknown attribute '// &
               trim(attributes(i)%name) &
          )
       end select
    end do

  end subroutine apply_attributes_gaussian
!###############################################################################


!###############################################################################
  pure function export_attributes_gaussian(this) result(attributes)
    !! Export Gaussian activation function attributes as ONNX attributes
    implicit none

    ! Arguments
    class(gaussian_actv_type), intent(in) :: this
    !! Gaussian activation type
    type(onnx_attribute_type), allocatable, dimension(:) :: attributes
    !! Array of ONNX attributes

    ! Local variables
    character(50) :: buffer
    !! Temporary string buffer

    allocate(attributes(4))

    write(buffer, '(A)') this%name
    attributes(1) = onnx_attribute_type( &
         "name", "string", trim(adjustl(buffer)) )

    write(buffer, '(F10.6)') this%scale
    attributes(2) = onnx_attribute_type( &
         "scale", "float", trim(adjustl(buffer)) )

    write(buffer, '(F10.6)') this%sigma
    attributes(3) = onnx_attribute_type( &
         "sigma", "float", trim(adjustl(buffer)) )

    write(buffer, '(F10.6)') this%mu
    attributes(4) = onnx_attribute_type( &
         "mu", "float", trim(adjustl(buffer)) )

  end function export_attributes_gaussian
!###############################################################################


!###############################################################################
  function apply_gaussian(this, val) result(output)
    !! Apply Gaussian activation to array
    !!
    !! Applies the Gaussian function element-wise to input array:
    !! f = exp(-x^2/(2σ^2))/(σ√(2π))
    implicit none

    ! Arguments
    class(gaussian_actv_type), intent(in) :: this
    !! Gaussian activation type containing sigma parameter
    type(array_type), intent(in) :: val
    !! Input values
    type(array_type), pointer :: output
    !! Gaussian activated output values

    if(this%apply_scaling)then
       output => gaussian(val, this%mu, this%sigma) * this%scale
    else
       output => gaussian(val, this%mu, this%sigma)
    end if

  end function apply_gaussian
!###############################################################################

end module athena__activation_gaussian