stdlib_linalg_state – Fortran-lang/stdlib

Provides a state/error handling derived type for advanced error handling of BLAS/LAPACK based linear algebra procedures. All procedures are pure. (Specification) Version: experimental

A fixed-storage state variable for error handling of linear algebra routines

Version: experimental

Error state handling: if the user requested the error state variable on output, just return it to the user. Otherwise, halt the program on error.

Version: experimental

Interfaces for comparison operators of error states with integer flags

Uses

Variables

Type	Visibility	Attributes		Name		Initial
integer(kind=ilp),	public,	parameter	::	LINALG_ERROR	=	-2_ilp
integer(kind=ilp),	public,	parameter	::	LINALG_INTERNAL_ERROR	=	-3_ilp
integer(kind=ilp),	public,	parameter	::	LINALG_SUCCESS	=	0_ilp	State return types
integer(kind=ilp),	public,	parameter	::	LINALG_VALUE_ERROR	=	-1_ilp

Interfaces

public interface linalg_state_type

private pure 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

Create state with no message

Add location

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	where_at	Location
integer,	intent(in)			::	flag	Input error flag
class(*),	intent(in),	optional,	dimension(..)	::	a1	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a2	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a3	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a4	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a5	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a6	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a7	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a8	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a9	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a10	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a11	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a12	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a13	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a14	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a15	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a16	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a17	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a18	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a19	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a20	Optional rank-agnostic arguments

Return Value type(linalg_state_type)

private pure 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) result(new_state)

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

Set error flag

Set chain

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag	Input error flag
class(*),	intent(in),	optional,	dimension(..)	::	a1	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a2	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a3	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a4	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a5	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a6	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a7	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a8	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a9	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a10	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a11	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a12	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a13	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a14	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a15	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a16	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a17	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a18	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a19	Optional rank-agnostic arguments
class(*),	intent(in),	optional,	dimension(..)	::	a20	Optional rank-agnostic arguments

Return Value type(linalg_state_type)

public interface operator(/=)

private elemental function state_neq_flag(err, flag)

Compare the error state with an integer flag

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	err
integer,	intent(in)			::	flag

Return Value logical(kind=lk)

private elemental function flag_neq_state(flag, err)

Compare an integer flag with the error state

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag
type(linalg_state_type),	intent(in)			::	err

Return Value logical(kind=lk)

public interface operator(<)

private elemental function state_lt_flag(err, flag)

Compare the error state with an integer flag

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	err
integer,	intent(in)			::	flag

Return Value logical(kind=lk)

private elemental function flag_lt_state(flag, err)

Compare an integer flag with the error state

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag
type(linalg_state_type),	intent(in)			::	err

Return Value logical(kind=lk)

public interface operator(<=)

private elemental function state_le_flag(err, flag)

Compare the error state with an integer flag

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	err
integer,	intent(in)			::	flag

Return Value logical(kind=lk)

private elemental function flag_le_state(flag, err)

Compare an integer flag with the error state

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag
type(linalg_state_type),	intent(in)			::	err

Return Value logical(kind=lk)

public interface operator(==)

Comparison operators

private elemental function state_eq_flag(err, flag)

Compare an error state with an integer flag

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	err
integer,	intent(in)			::	flag

Return Value logical(kind=lk)

private elemental function flag_eq_state(flag, err)

Compare an integer flag with the error state

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag
type(linalg_state_type),	intent(in)			::	err

Return Value logical(kind=lk)

public interface operator(>)

private elemental function state_gt_flag(err, flag)

Compare the error state with an integer flag

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	err
integer,	intent(in)			::	flag

Return Value logical(kind=lk)

private elemental function flag_gt_state(flag, err)

Compare an integer flag with the error state

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag
type(linalg_state_type),	intent(in)			::	err

Return Value logical(kind=lk)

public interface operator(>=)

private elemental function state_ge_flag(err, flag)

Compare the error state with an integer flag

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	err
integer,	intent(in)			::	flag

Return Value logical(kind=lk)

private elemental function flag_ge_state(flag, err)

Compare an integer flag with the error state

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	flag
type(linalg_state_type),	intent(in)			::	err

Return Value logical(kind=lk)

Derived Types

type, public :: linalg_state_type

linalg_state_type defines a state return type for a linear algebra routine. State contains a status flag, a comment, and a procedure specifier that can be used to mark where the error happened

Components

Type	Visibility		Name		Initial
character(len=MSG_LENGTH),	public	::	message	=	repeat(' ', MSG_LENGTH)	Message associated to the current state
integer(kind=ilp),	public	::	state	=	LINALG_SUCCESS	The current exit state
character(len=NAME_LENGTH),	public	::	where_at	=	repeat(' ', NAME_LENGTH)	Location of the state change

Constructor

private pure 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 Create state with no message Add location
private pure 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) Set error flag Set chain

Type-Bound Procedures

procedure, public :: destroy => state_destroy	../../ Cleanup
procedure, public :: error => state_is_error
procedure, public :: ok => state_is_ok	../../ State properties
procedure, public :: print => state_print	../../ Print error message
procedure, public :: print_msg => state_message

Subroutines

public pure subroutine linalg_error_handling(ierr, ierr_out)

Flow control: on output flag present, return it; otherwise, halt on error

Arguments

Type	Intent	Optional	Attributes		Name
type(linalg_state_type),	intent(in)			::	ierr
type(linalg_state_type),	intent(out),	optional		::	ierr_out

stdlib_linalg_state Module

Contents

Variables

Interfaces

Derived Types

Subroutines

Uses

Variables

Interfaces

public interface linalg_state_type

private pure 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)

Arguments

Return Value type(linalg_state_type)

private pure 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) result(new_state)

Arguments

Return Value type(linalg_state_type)

public interface operator(/=)

private elemental function state_neq_flag(err, flag)

Arguments

Return Value logical(kind=lk)

private elemental function flag_neq_state(flag, err)

Arguments

Return Value logical(kind=lk)

public interface operator(<)

private elemental function state_lt_flag(err, flag)

Arguments

Return Value logical(kind=lk)

private elemental function flag_lt_state(flag, err)

Arguments

Return Value logical(kind=lk)

public interface operator(<=)

private elemental function state_le_flag(err, flag)

Arguments

Return Value logical(kind=lk)

private elemental function flag_le_state(flag, err)

Arguments

Return Value logical(kind=lk)

public interface operator(==)

private elemental function state_eq_flag(err, flag)

Arguments

Return Value logical(kind=lk)

private elemental function flag_eq_state(flag, err)

Arguments

Return Value logical(kind=lk)

public interface operator(>)

private elemental function state_gt_flag(err, flag)

Arguments

Return Value logical(kind=lk)

private elemental function flag_gt_state(flag, err)

Arguments

Return Value logical(kind=lk)

public interface operator(>=)

private elemental function state_ge_flag(err, flag)

Arguments

Return Value logical(kind=lk)

private elemental function flag_ge_state(flag, err)

Arguments

Return Value logical(kind=lk)

Derived Types

type, public :: linalg_state_type

Components

Constructor

Type-Bound Procedures

Subroutines

public pure subroutine linalg_error_handling(ierr, ierr_out)

Arguments