GCC Code Coverage Report

Directory:	src/athena/
File:	src/athena/athena_initialiser.f90
Date:	2026-04-15 16:08:59

	Exec	Total	Coverage
Lines:	28	40	70.0%
Functions:	0	0	-%
Branches:	74	208	35.6%

  
      Line
      Branch
      Exec
      Source
    
      module athena__initialiser
    
        !! Module containing functions to set up initialisers
    
        !!
    
        !! This module contains functions to set up initialisers for the weights and
    
        !! biases of a neural network model
    
        !! Examples of initialsers in keras: https://keras.io/api/layers/initializers/
    
        use coreutils, only: stop_program, to_lower
    
        use athena__misc_types, only: base_init_type
    
        use athena__initialiser_glorot, only: &
    
             glorot_uniform_init_type, glorot_normal_init_type
    
        use athena__initialiser_he, only: he_uniform_init_type, he_normal_init_type
    
        use athena__initialiser_lecun, only: &
    
             lecun_uniform_init_type, lecun_normal_init_type
    
        use athena__initialiser_ones, only: ones_init_type
    
        use athena__initialiser_zeros, only: zeros_init_type
    
        use athena__initialiser_ident, only: ident_init_type
    
        use athena__initialiser_gaussian, only: gaussian_init_type
    
        implicit none
    
        private
    
        public :: initialiser_setup, get_default_initialiser
    
      contains
    
      !###############################################################################
    
      349
        function get_default_initialiser(activation, is_bias) result(name)
    
          !! Get the default initialiser based on the activation function
    
          implicit none
    
          ! Arguments
    
          character(*), intent(in) :: activation
    
          !! Activation function
    
          logical, optional, intent(in) :: is_bias
    
          !! Boolean whether initialiser is for bias
    
          character(:), allocatable :: name
    
          !---------------------------------------------------------------------------
    
          ! If bias, use default initialiser of zero
    
          !---------------------------------------------------------------------------
    
      349
          if(present(is_bias))then
    
        4/10✓ Branch 0 taken 191 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 191 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✓ Branch 6 taken 191 times.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 191 times.

      191
             if(is_bias) name = "zeros"
    
      191
             return
    
          end if
    
          !---------------------------------------------------------------------------
    
          ! Set default initialiser based on activation
    
          !---------------------------------------------------------------------------
    
        3/4✓ Branch 1 taken 158 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 1 times.
✓ Branch 4 taken 157 times.

      158
          if(trim(activation).eq."selu")then
    
        3/8✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 1 times.

      1
             name = "lecun_normal"
    
        2/2✓ Branch 0 taken 28 times.
✓ Branch 1 taken 129 times.

      157
          elseif(index(activation,"elu").ne.0)then
    
        3/8✓ Branch 0 taken 28 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 28 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 28 times.

      28
             name = "he_uniform"
    
        3/4✓ Branch 1 taken 129 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 1 times.
✓ Branch 4 taken 128 times.

      129
          elseif(trim(activation).eq."batch")then
    
        3/8✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 1 times.

      1
             name = "gaussian"
    
          else
    
        3/8✓ Branch 0 taken 128 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 128 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 128 times.

      128
             name = "glorot_uniform"
    
          end if
    
        4/4✓ Branch 0 taken 191 times.
✓ Branch 1 taken 158 times.
✓ Branch 2 taken 158 times.
✓ Branch 3 taken 191 times.

      698
        end function get_default_initialiser
    
      !###############################################################################
    
      !###############################################################################
    
      581
        function initialiser_setup(input, error) result(initialiser)
    
          !! Set up the initialiser function
    
          implicit none
    
          ! Arguments
    
          class(base_init_type), allocatable :: initialiser
    
          !! Initialiser function
    
          class(*) :: input
    
          !! Name of initialiser or initialiser object
    
          integer, optional, intent(out) :: error
    
          !! Error code
    
          ! Local variables
    
          character(256) :: err_msg
    
          !! Error message
    
          !---------------------------------------------------------------------------
    
          ! Set initialiser function
    
          !---------------------------------------------------------------------------
    
          select type(input)
    
          class is(base_init_type)
    
      ✗
             initialiser = input
    
          type is(character(*))
    
      1162
             select case(trim(to_lower(input)))
    
             case("glorot_uniform")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 132 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 132 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 132 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      132
                initialiser = glorot_uniform_init_type()
    
             case("glorot_normal")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 4 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 4 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      4
                initialiser = glorot_normal_init_type()
    
             case("he_uniform")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 31 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 6 taken 31 times.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 31 times.
✗ Branch 11 not taken.
✗ Branch 12 not taken.

      31
                initialiser = he_uniform_init_type()
    
             case("he_normal")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 6 taken 7 times.
✗ Branch 7 not taken.
✗ Branch 8 not taken.
✓ Branch 9 taken 7 times.
✗ Branch 11 not taken.
✗ Branch 12 not taken.

      7
                initialiser = he_normal_init_type()
    
             case("lecun_uniform")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 4 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 4 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      4
                initialiser = lecun_uniform_init_type()
    
             case("lecun_normal")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 4 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 4 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      4
                initialiser = lecun_normal_init_type()
    
             case("ones")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 86 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 86 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 86 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      86
                initialiser = ones_init_type()
    
             case("zeros")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 295 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 295 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 295 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      295
                initialiser = zeros_init_type()
    
             case("ident")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 4 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 4 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      4
                initialiser = ident_init_type()
    
             case("gaussian")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 10 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 10 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      10
                initialiser = gaussian_init_type()
    
             case("normal")
    
        3/10✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 5 taken 4 times.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 4 times.
✗ Branch 10 not taken.
✗ Branch 11 not taken.

      4
                initialiser = gaussian_init_type(name="normal")
    
             case default
    
        12/16✓ Branch 1 taken 581 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 132 times.
✓ Branch 4 taken 4 times.
✓ Branch 5 taken 31 times.
✓ Branch 6 taken 7 times.
✓ Branch 7 taken 4 times.
✓ Branch 8 taken 4 times.
✓ Branch 9 taken 86 times.
✓ Branch 10 taken 295 times.
✓ Branch 11 taken 4 times.
✓ Branch 12 taken 10 times.
✓ Branch 13 taken 4 times.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
✗ Branch 16 not taken.

      1743
                if(present(error))then
    
      ✗
                   error = -1
    
      ✗
                   return
    
                else
    
                   write(err_msg,'("Incorrect initialiser name given ''",A,"''")') &
    
      ✗
                        trim(to_lower(input))
    
      ✗
                   call stop_program(trim(err_msg))
    
      ✗
                   return
    
                end if
    
             end select
    
          class default
    
      ✗
             if(present(error))then
    
      ✗
                error = -1
    
      ✗
                return
    
             else
    
      ✗
                write(err_msg,'("Unknown input type given for initialiser setup")')
    
      ✗
                call stop_program(trim(err_msg))
    
      ✗
                return
    
             end if
    
          end select
    
      581
        end function initialiser_setup
    
      !###############################################################################
    
        1/8✓ Branch 0 taken 581 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 8 not taken.

      581
      end module athena__initialiser

Line	Branch	Exec	Source
1			module athena__initialiser
2			!! Module containing functions to set up initialisers
3			!!
4			!! This module contains functions to set up initialisers for the weights and
5			!! biases of a neural network model
6			!! Examples of initialsers in keras: https://keras.io/api/layers/initializers/
7			use coreutils, only: stop_program, to_lower
8			use athena__misc_types, only: base_init_type
9			use athena__initialiser_glorot, only: &
10			glorot_uniform_init_type, glorot_normal_init_type
11			use athena__initialiser_he, only: he_uniform_init_type, he_normal_init_type
12			use athena__initialiser_lecun, only: &
13			lecun_uniform_init_type, lecun_normal_init_type
14			use athena__initialiser_ones, only: ones_init_type
15			use athena__initialiser_zeros, only: zeros_init_type
16			use athena__initialiser_ident, only: ident_init_type
17			use athena__initialiser_gaussian, only: gaussian_init_type
18			implicit none
19
20
21			private
22
23			public :: initialiser_setup, get_default_initialiser
24
25
26			contains
27
28			!###############################################################################
29		349	function get_default_initialiser(activation, is_bias) result(name)
30			!! Get the default initialiser based on the activation function
31			implicit none
32
33			! Arguments
34			character(*), intent(in) :: activation
35			!! Activation function
36			logical, optional, intent(in) :: is_bias
37			!! Boolean whether initialiser is for bias
38
39			character(:), allocatable :: name
40
41
42			!---------------------------------------------------------------------------
43			! If bias, use default initialiser of zero
44			!---------------------------------------------------------------------------
45		349	if(present(is_bias))then
46	4/10 ✓ Branch 0 taken 191 times. ✗ Branch 1 not taken. ✓ Branch 2 taken 191 times. ✗ Branch 3 not taken. ✗ Branch 4 not taken. ✗ Branch 5 not taken. ✓ Branch 6 taken 191 times. ✗ Branch 7 not taken. ✗ Branch 8 not taken. ✓ Branch 9 taken 191 times.	191	if(is_bias) name = "zeros"
47		191	return
48			end if
49
50
51			!---------------------------------------------------------------------------
52			! Set default initialiser based on activation
53			!---------------------------------------------------------------------------
54	3/4 ✓ Branch 1 taken 158 times. ✗ Branch 2 not taken. ✓ Branch 3 taken 1 times. ✓ Branch 4 taken 157 times.	158	if(trim(activation).eq."selu")then
55	3/8 ✓ Branch 0 taken 1 times. ✗ Branch 1 not taken. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 4 taken 1 times. ✗ Branch 5 not taken. ✗ Branch 6 not taken. ✓ Branch 7 taken 1 times.	1	name = "lecun_normal"
56	2/2 ✓ Branch 0 taken 28 times. ✓ Branch 1 taken 129 times.	157	elseif(index(activation,"elu").ne.0)then
57	3/8 ✓ Branch 0 taken 28 times. ✗ Branch 1 not taken. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 4 taken 28 times. ✗ Branch 5 not taken. ✗ Branch 6 not taken. ✓ Branch 7 taken 28 times.	28	name = "he_uniform"
58	3/4 ✓ Branch 1 taken 129 times. ✗ Branch 2 not taken. ✓ Branch 3 taken 1 times. ✓ Branch 4 taken 128 times.	129	elseif(trim(activation).eq."batch")then
59	3/8 ✓ Branch 0 taken 1 times. ✗ Branch 1 not taken. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 4 taken 1 times. ✗ Branch 5 not taken. ✗ Branch 6 not taken. ✓ Branch 7 taken 1 times.	1	name = "gaussian"
60			else
61	3/8 ✓ Branch 0 taken 128 times. ✗ Branch 1 not taken. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 4 taken 128 times. ✗ Branch 5 not taken. ✗ Branch 6 not taken. ✓ Branch 7 taken 128 times.	128	name = "glorot_uniform"
62			end if
63
64	4/4 ✓ Branch 0 taken 191 times. ✓ Branch 1 taken 158 times. ✓ Branch 2 taken 158 times. ✓ Branch 3 taken 191 times.	698	end function get_default_initialiser
65			!###############################################################################
66
67
68			!###############################################################################
69		581	function initialiser_setup(input, error) result(initialiser)
70			!! Set up the initialiser function
71			implicit none
72
73			! Arguments
74			class(base_init_type), allocatable :: initialiser
75			!! Initialiser function
76			class(*) :: input
77			!! Name of initialiser or initialiser object
78			integer, optional, intent(out) :: error
79			!! Error code
80
81			! Local variables
82			character(256) :: err_msg
83			!! Error message
84
85
86			!---------------------------------------------------------------------------
87			! Set initialiser function
88			!---------------------------------------------------------------------------
89			select type(input)
90			class is(base_init_type)
91		✗	initialiser = input
92			type is(character(*))
93		1162	select case(trim(to_lower(input)))
94			case("glorot_uniform")
95	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 132 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 132 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 132 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	132	initialiser = glorot_uniform_init_type()
96			case("glorot_normal")
97	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 4 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 4 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 4 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	4	initialiser = glorot_normal_init_type()
98			case("he_uniform")
99	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 31 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 6 taken 31 times. ✗ Branch 7 not taken. ✗ Branch 8 not taken. ✓ Branch 9 taken 31 times. ✗ Branch 11 not taken. ✗ Branch 12 not taken.	31	initialiser = he_uniform_init_type()
100			case("he_normal")
101	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 7 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 6 taken 7 times. ✗ Branch 7 not taken. ✗ Branch 8 not taken. ✓ Branch 9 taken 7 times. ✗ Branch 11 not taken. ✗ Branch 12 not taken.	7	initialiser = he_normal_init_type()
102			case("lecun_uniform")
103	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 4 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 4 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 4 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	4	initialiser = lecun_uniform_init_type()
104			case("lecun_normal")
105	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 4 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 4 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 4 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	4	initialiser = lecun_normal_init_type()
106			case("ones")
107	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 86 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 86 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 86 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	86	initialiser = ones_init_type()
108			case("zeros")
109	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 295 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 295 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 295 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	295	initialiser = zeros_init_type()
110			case("ident")
111	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 4 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 4 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 4 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	4	initialiser = ident_init_type()
112			case("gaussian")
113	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 10 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 10 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 10 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	10	initialiser = gaussian_init_type()
114			case("normal")
115	3/10 ✗ Branch 0 not taken. ✓ Branch 1 taken 4 times. ✗ Branch 2 not taken. ✗ Branch 3 not taken. ✓ Branch 5 taken 4 times. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✓ Branch 8 taken 4 times. ✗ Branch 10 not taken. ✗ Branch 11 not taken.	4	initialiser = gaussian_init_type(name="normal")
116			case default
117	12/16 ✓ Branch 1 taken 581 times. ✗ Branch 2 not taken. ✓ Branch 3 taken 132 times. ✓ Branch 4 taken 4 times. ✓ Branch 5 taken 31 times. ✓ Branch 6 taken 7 times. ✓ Branch 7 taken 4 times. ✓ Branch 8 taken 4 times. ✓ Branch 9 taken 86 times. ✓ Branch 10 taken 295 times. ✓ Branch 11 taken 4 times. ✓ Branch 12 taken 10 times. ✓ Branch 13 taken 4 times. ✗ Branch 14 not taken. ✗ Branch 15 not taken. ✗ Branch 16 not taken.	1743	if(present(error))then
118		✗	error = -1
119		✗	return
120			else
121			write(err_msg,'("Incorrect initialiser name given ''",A,"''")') &
122		✗	trim(to_lower(input))
123		✗	call stop_program(trim(err_msg))
124		✗	return
125			end if
126			end select
127			class default
128		✗	if(present(error))then
129		✗	error = -1
130		✗	return
131			else
132		✗	write(err_msg,'("Unknown input type given for initialiser setup")')
133		✗	call stop_program(trim(err_msg))
134		✗	return
135			end if
136			end select
137
138		581	end function initialiser_setup
139			!###############################################################################
140
141	1/8 ✓ Branch 0 taken 581 times. ✗ Branch 1 not taken. ✗ Branch 3 not taken. ✗ Branch 4 not taken. ✗ Branch 5 not taken. ✗ Branch 6 not taken. ✗ Branch 7 not taken. ✗ Branch 8 not taken.	581	end module athena__initialiser
142