Preprocessing

Often, several criteria may require the same preprocessing steps before performing their margin checks.

When criteria are grouped into the same 'Pre-Processing Set', the set's 'Preprocessing' function is guaranteed to be called before any of the AnalyzeFuncs of the criteria in the set. The result of the preprocessing step is available to each criterion.

Note

As of Solver API 1.23.0, it is not safe to store an entire IPlateRep, IBeamRep, or IAnalyzable as pre-processed data. Extract the pieces of data you wish to to use and store that instead.

The following code demonstrates how two or more criterion might share the same preprocessing step.

using HyperX.Solver.Api;
 
namespace Solver.Criteria.Sample;
 
public class PreProcessSample : CriterionModule
{
    public override CriteriaConfig GetCriteria()
    {
        var config = new CriteriaConfig();
 
        var definition1 = new CriterionDefinitionConfig()
            .WithName("First")
            .WithVersion(1, 0, 0)
            .WithUid("00000000-0000-0000-0000-REPLACEME001")
            .WithReferenceId("S04")
            .WithAnalyzeFunc(x => Compute(x, CriterionId.First));
 
        var definition2 = new CriterionDefinitionConfig()
            .WithName("Second")
            .WithVersion(1, 0, 0)
            .WithUid("00000000-0000-0000-0000-REPLACEME002")
            .WithReferenceId("S05")
            .WithAnalyzeFunc(x => Compute(x, CriterionId.Second));
 
        _ = config.AddSet([definition1, definition2], PreProcess);
 
        return config;
    }
 
    private void PreProcess(ICriterionInput input, IPreProcessedData outData)
    {
        outData.AddData("load_scenario_uid", input.Analyzable.LoadId);
        outData.AddData(1, "hello");
 
        _ = input.Details.Add("Module", $"From {nameof(PreProcessSample)}");
        _ = input.Details.Add("Analyzable", $"{input.Analyzable}");
        _ = input.Details.Add("Scenario", $"{input.Analyzable.LoadId}");
 
        Dictionary<CriterionId, AnalysisResult> results = new()
        {
            { CriterionId.First, new AnalysisResult(0.06, input.Details) },
            { CriterionId.Second, new AnalysisResult(0.07, input.Details) },
        };
 
        outData.AddData("results", results);
    }
 
    private static AnalysisResult Compute(ICriterionInput input, CriterionId id)
    {
        var data = input.PreprocessedData;
        if (data.GetData("results") is not Dictionary<CriterionId, AnalysisResult> results)
        {
            throw new InvalidOperationException("No preprocessed results found");
        }
 
        var result = results[id];
        _ = result.SingleLoadResult?.Details.Add("criterion scenario", $"{input.Analyzable.LoadId}");
        return result;
    }
}
 
internal enum CriterionId
{
    First,
    Second,
}