Defines a state return type for a linear algebra routine. More...

Public Member Functions
procedure	destroy (this)
	Destroy the state object.

procedure	handle (ierr, ierr_out)
	Handle errors based on the state value.

procedure	print (this)
	Print the error message associated with the state.

procedure	print_msg (this)
	Formatted message.

procedure	ok (this)
	Check if the state indicates success.

procedure	error (this)
	Check if the state indicates an error.

pure type(la_state) function	new_state (where_at, flag, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20)
	Error creation message, with location location.

pure type(la_state) function	new_state_nowhere (flag, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20)
	Error creation message, from N input variables (numeric or strings)

Public Attributes
integer(ilp)	state = LINALG_SUCCESS
	The current exit state.

character(len=msg_length)	message = repeat(' ', MSG_LENGTH)
	Message associated with the current state.

character(len=name_length)	where_at = repeat(' ', NAME_LENGTH)
	Location where the state change occurred.

Detailed Description

Defines a state return type for a linear algebra routine.

This type encapsulates a status flag, an optional error message, and the procedure name where the error originated.

Member Function/Subroutine Documentation

◆ destroy()

procedure la_state_type::la_state::destroy ( class(la_state), intent(inout) this )

Destroy the state object.

◆ error()

procedure la_state_type::la_state::error ( class(la_state), intent(in) this )

Check if the state indicates an error.

◆ handle()

procedure la_state_type::la_state::handle	(	class(la_state), intent(in)	ierr,
		type(la_state), intent(out), optional	ierr_out )

Handle errors based on the state value.

◆ new_state()

pure type(la_state) function la_state_type::la_state::new_state	(	character(len=*), intent(in)	where_at,
		integer, intent(in)	flag,
		class(*), dimension(..), intent(in), optional	a1,
		class(*), dimension(..), intent(in), optional	a2,
		class(*), dimension(..), intent(in), optional	a3,
		class(*), dimension(..), intent(in), optional	a4,
		class(*), dimension(..), intent(in), optional	a5,
		class(*), dimension(..), intent(in), optional	a6,
		class(*), dimension(..), intent(in), optional	a7,
		class(*), dimension(..), intent(in), optional	a8,
		class(*), dimension(..), intent(in), optional	a9,
		class(*), dimension(..), intent(in), optional	a10,
		class(*), dimension(..), intent(in), optional	a11,
		class(*), dimension(..), intent(in), optional	a12,
		class(*), dimension(..), intent(in), optional	a13,
		class(*), dimension(..), intent(in), optional	a14,
		class(*), dimension(..), intent(in), optional	a15,
		class(*), dimension(..), intent(in), optional	a16,
		class(*), dimension(..), intent(in), optional	a17,
		class(*), dimension(..), intent(in), optional	a18,
		class(*), dimension(..), intent(in), optional	a19,
		class(*), dimension(..), intent(in), optional	a20 )

Error creation message, with location location.

Parameters

[in]	where_at	Location
[in]	flag	Input error flag
[in]	a1	Optional rank-agnostic arguments
[in]	a2	Optional rank-agnostic arguments
[in]	a3	Optional rank-agnostic arguments
[in]	a4	Optional rank-agnostic arguments
[in]	a5	Optional rank-agnostic arguments
[in]	a6	Optional rank-agnostic arguments
[in]	a7	Optional rank-agnostic arguments
[in]	a8	Optional rank-agnostic arguments
[in]	a9	Optional rank-agnostic arguments
[in]	a10	Optional rank-agnostic arguments
[in]	a11	Optional rank-agnostic arguments
[in]	a12	Optional rank-agnostic arguments
[in]	a13	Optional rank-agnostic arguments
[in]	a14	Optional rank-agnostic arguments
[in]	a15	Optional rank-agnostic arguments
[in]	a16	Optional rank-agnostic arguments
[in]	a17	Optional rank-agnostic arguments
[in]	a18	Optional rank-agnostic arguments
[in]	a19	Optional rank-agnostic arguments
[in]	a20	Optional rank-agnostic arguments

◆ new_state_nowhere()

pure type(la_state) function la_state_type::la_state::new_state_nowhere	(	integer, intent(in)	flag,
		class(*), dimension(..), intent(in), optional	a1,
		class(*), dimension(..), intent(in), optional	a2,
		class(*), dimension(..), intent(in), optional	a3,
		class(*), dimension(..), intent(in), optional	a4,
		class(*), dimension(..), intent(in), optional	a5,
		class(*), dimension(..), intent(in), optional	a6,
		class(*), dimension(..), intent(in), optional	a7,
		class(*), dimension(..), intent(in), optional	a8,
		class(*), dimension(..), intent(in), optional	a9,
		class(*), dimension(..), intent(in), optional	a10,
		class(*), dimension(..), intent(in), optional	a11,
		class(*), dimension(..), intent(in), optional	a12,
		class(*), dimension(..), intent(in), optional	a13,
		class(*), dimension(..), intent(in), optional	a14,
		class(*), dimension(..), intent(in), optional	a15,
		class(*), dimension(..), intent(in), optional	a16,
		class(*), dimension(..), intent(in), optional	a17,
		class(*), dimension(..), intent(in), optional	a18,
		class(*), dimension(..), intent(in), optional	a19,
		class(*), dimension(..), intent(in), optional	a20 )

Error creation message, from N input variables (numeric or strings)

Parameters

[in]	flag	Input error flag
[in]	a1	Optional rank-agnostic arguments
[in]	a2	Optional rank-agnostic arguments
[in]	a3	Optional rank-agnostic arguments
[in]	a4	Optional rank-agnostic arguments
[in]	a5	Optional rank-agnostic arguments
[in]	a6	Optional rank-agnostic arguments
[in]	a7	Optional rank-agnostic arguments
[in]	a8	Optional rank-agnostic arguments
[in]	a9	Optional rank-agnostic arguments
[in]	a10	Optional rank-agnostic arguments
[in]	a11	Optional rank-agnostic arguments
[in]	a12	Optional rank-agnostic arguments
[in]	a13	Optional rank-agnostic arguments
[in]	a14	Optional rank-agnostic arguments
[in]	a15	Optional rank-agnostic arguments
[in]	a16	Optional rank-agnostic arguments
[in]	a17	Optional rank-agnostic arguments
[in]	a18	Optional rank-agnostic arguments
[in]	a19	Optional rank-agnostic arguments
[in]	a20	Optional rank-agnostic arguments

◆ ok()

procedure la_state_type::la_state::ok ( class(la_state), intent(in) this )

Check if the state indicates success.

◆ print()

procedure la_state_type::la_state::print ( class(la_state), intent(in) this )

Print the error message associated with the state.

◆ print_msg()

procedure la_state_type::la_state::print_msg ( class(la_state), intent(in) this )

Formatted message.

Member Data Documentation

◆ message

character(len=msg_length) la_state_type::la_state::message = repeat(' ', MSG_LENGTH)

Message associated with the current state.

◆ state

integer(ilp) la_state_type::la_state::state = LINALG_SUCCESS

The current exit state.

◆ where_at

character(len=name_length) la_state_type::la_state::where_at = repeat(' ', NAME_LENGTH)

Location where the state change occurred.

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

la_state.f90

Public Member Functions

Public Attributes