Class CalibrationResult

java.lang.Object
neqsim.process.calibration.CalibrationResult
All Implemented Interfaces:
Serializable
public class CalibrationResult extends Object implements Serializable
Represents the result of a calibration operation.

Contains the calibrated parameters, quality metrics, and status information.

Version:
1.0
Author:
ESOL
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • success

      private final boolean success

    • parameters

      private final Map<String,Double> parameters

    • rmse

      private final double rmse

    • iterations

      private final int iterations

    • samplesUsed

      private final int samplesUsed

    • errorMessage

      private final String errorMessage

  • Constructor Details

    • CalibrationResult

      private CalibrationResult(boolean success, Map<String,Double> parameters, double rmse, int iterations, int samplesUsed, String errorMessage)
      Private constructor - use factory methods.
      Parameters:
      success - whether calibration was successful
      parameters - the calibrated parameters
      rmse - the root mean square error
      iterations - number of iterations used
      samplesUsed - number of samples used
      errorMessage - error message if failed

  • Method Details

    • success

      public static CalibrationResult success(Map<String,Double> parameters, double rmse, int iterations, int samplesUsed)
      Creates a successful calibration result.
      Parameters:
      parameters - the calibrated parameters
      rmse - the root mean square error achieved
      iterations - number of iterations used
      samplesUsed - number of samples used
      Returns:
      successful calibration result

    • failure

      public static CalibrationResult failure(String errorMessage)
      Creates a failed calibration result.
      Parameters:
      errorMessage - description of the failure
      Returns:
      failed calibration result

    • isSuccess

      public boolean isSuccess()
      Checks if calibration was successful.
      Returns:
      true if successful

    • isSuccessful

      public boolean isSuccessful()
      Alias for isSuccess() for compatibility.
      Returns:
      true if successful

    • getParameters

      public Map<String,Double> getParameters()
      Gets the calibrated parameters.
      Returns:
      map of parameter names to values, or null if failed

    • getCalibratedParameters

      public Map<String,Double> getCalibratedParameters()
      Alias for getParameters() for compatibility.
      Returns:
      map of parameter names to values, or null if failed

    • getRmse

      public double getRmse()
      Gets the RMSE achieved.
      Returns:
      root mean square error

    • getIterations

      public int getIterations()
      Gets the number of iterations used.
      Returns:
      iteration count

    • getSamplesUsed

      public int getSamplesUsed()
      Gets the number of samples used.
      Returns:
      sample count

    • getErrorMessage

      public String getErrorMessage()
      Gets the error message if calibration failed.
      Returns:
      error message or null if successful

    • getMessage

      public String getMessage()
      Alias for getErrorMessage() for compatibility.
      Returns:
      error message or null if successful

    • toString

      public String toString()
      Overrides:
      toString in class Object