Skip to content

Commit 4fa3af5

Browse files
committed
Add doc in solver
1 parent 491139d commit 4fa3af5

1 file changed

Lines changed: 34 additions & 3 deletions

File tree

fortran/solver/src/solver.f90

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,30 @@ module solver_mod
33
use task_mod, only: task_t
44
implicit none
55
private
6+
7+
!> @brief task solver
68
type :: solver_t
7-
logical(1) :: inited = .false.
8-
type(library_t) :: library
9-
type(task_t) :: task
9+
logical(1) :: inited = .false. !< was initialised
10+
type(library_t) :: library !< labyrinth description
11+
type(task_t) :: task !< problem / task
1012
contains
1113
procedure :: init
1214
procedure :: solve
1315
procedure :: submit
1416
end type solver_t
17+
1518
public :: solver_t
1619
contains
20+
21+
!>
22+
!> @brief initialise solver_t
23+
!>
24+
!> @param[in,out] solver - solver_t object
25+
!> @param[in] arg - task name
26+
!>
27+
!> @author foxtran
28+
!> @date Sep 8, 2025
29+
!>
1730
subroutine init(solver, arg)
1831
use API_mod, only: select, explore
1932
use plan_mod, only: plan_t
@@ -54,6 +67,15 @@ function generate_plans(task) result(plans)
5467
end if
5568
end function generate_plans
5669
end subroutine init
70+
71+
!>
72+
!> @brief solve task
73+
!>
74+
!> @param[in,out] solver - solver_t object
75+
!>
76+
!> @author foxtran
77+
!> @date Sep 8, 2025
78+
!>
5779
subroutine solve(solver)
5880
use guess_mod, only: guess_t
5981
class(solver_t), intent(inout) :: solver
@@ -89,6 +111,15 @@ subroutine solve(solver)
89111
if (corr_id < 0) error stop "solution not found"
90112
call guess(corr_id)%set_solution(solver%library)
91113
end subroutine solve
114+
115+
!>
116+
!> @brief submit solution
117+
!>
118+
!> @param[in,out] solver - solver_t object
119+
!>
120+
!> @author foxtran
121+
!> @date Sep 8, 2025
122+
!>
92123
subroutine submit(solver)
93124
use solution_mod, only: solution_t
94125
use API_mod, only: guess

0 commit comments

Comments
 (0)