PineForge HPO 1.11.0
Native hyperparameter optimization for PineForge strategies
Loading...
Searching...
No Matches
pineforge::hpo::TrialExecutionResult Struct Reference

Result envelope returned by TrialExecutor::execute(). More...

#include <pineforge/hpo/trial_executor.hpp>

Public Member Functions

bool succeeded () const noexcept
 Returns whether status is TrialExecutionStatus::kSucceeded.
 

Public Attributes

TrialExecutionStatus status = TrialExecutionStatus::kEngineError
 Machine-readable terminal status.
 
std::string error
 Strategy error text when status is TrialExecutionStatus::kEngineError.
 
std::optional< std::string > error_code
 Engine-owned failure code; absent for plugins without the optional getter.
 
std::optional< std::string > error_args
 Raw engine argument JSON; consumers must validate it before serialization.
 
ReportSnapshot report
 Detached report populated when execution succeeds.
 

Detailed Description

Result envelope returned by TrialExecutor::execute().

Definition at line 210 of file trial_executor.hpp.

Member Function Documentation

◆ succeeded()

bool pineforge::hpo::TrialExecutionResult::succeeded ( ) const
inlinenoexcept

Returns whether status is TrialExecutionStatus::kSucceeded.

Definition at line 223 of file trial_executor.hpp.

References pineforge::hpo::kSucceeded, and status.

Member Data Documentation

◆ error

std::string pineforge::hpo::TrialExecutionResult::error

Strategy error text when status is TrialExecutionStatus::kEngineError.

Definition at line 214 of file trial_executor.hpp.

◆ error_args

std::optional<std::string> pineforge::hpo::TrialExecutionResult::error_args

Raw engine argument JSON; consumers must validate it before serialization.

Definition at line 218 of file trial_executor.hpp.

◆ error_code

std::optional<std::string> pineforge::hpo::TrialExecutionResult::error_code

Engine-owned failure code; absent for plugins without the optional getter.

Definition at line 216 of file trial_executor.hpp.

◆ report

ReportSnapshot pineforge::hpo::TrialExecutionResult::report

Detached report populated when execution succeeds.

Definition at line 220 of file trial_executor.hpp.

◆ status

TrialExecutionStatus pineforge::hpo::TrialExecutionResult::status = TrialExecutionStatus::kEngineError

Machine-readable terminal status.

Definition at line 212 of file trial_executor.hpp.

Referenced by succeeded().


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