doe_evaluate_model Interface

public interface doe_evaluate_model

Contents

Module Procedures


Module Procedures

private function doe_evaluate_model_1(nway, beta, x, map, err) result(rst)

Evaluates the model of the following form.

Arguments

Type IntentOptional Attributes Name
integer(kind=int32), intent(in) :: nway

The number of interaction levels. Currently, this algorithm supports a maximum of three-way interaction.
real(kind=real64), intent(in), dimension(:) :: beta

The model coefficients.
real(kind=real64), intent(in), dimension(:,:) :: x

The M-by-N matrix containing the M values of each of the N factors at which to evaluate the model.
logical, intent(in), optional, target, dimension(:) :: map

An optional array of the same size as beta that can be used to eliminate a parameter from the model (false), or keep a parameter in the model (true). If not supplied, all parameters will be assumed to be part of the model as if the array were filled with all true values.
class(errors), intent(inout), optional, target :: err

A mechanism for communicating errors and warnings to the caller. Possible warning and error codes are as follows. - FS_NO_ERROR: No errors encountered. - FS_ARRAY_SIZE_ERROR: Occurs if beta and map are not properly sized relative to one another. - FS_MEMORY_ERROR: Occurs if there is a memory allocation error. - FS_INVALID_INPUT_ERROR: Occurs if nway is less than 1 or greater than 3.

Return Value real(kind=real64), allocatable, dimension(:)

The resulting M-element array.

private function doe_evaluate_model_2(mdl, x, err) result(rst)

Evaluates the model of the following form.

Arguments

Type IntentOptional Attributes Name
class(doe_model), intent(in) :: mdl

The model to evaluate.
real(kind=real64), intent(in), dimension(:,:) :: x

The M-by-N matrix containing the M values of each of the N factors at which to evaluate the model.
class(errors), intent(inout), optional, target :: err

A mechanism for communicating errors and warnings to the caller. Possible warning and error codes are as follows. - FS_NO_ERROR: No errors encountered. - FS_MEMORY_ERROR: Occurs if there is a memory allocation error.

Return Value real(kind=real64), allocatable, dimension(:)

The resulting M-element array.