Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
neural_hybrid.h File Reference

Analytic+residual neural hybrid operator scaffolding. More...

#include "neural_infer.h"
Include dependency graph for neural_hybrid.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SimNeuralHybridOperatorConfig
 Configuration for analytic + neural residual hybrid operator. More...
 

Typedefs

typedef struct SimNeuralHybridOperatorConfig SimNeuralHybridOperatorConfig
 Configuration for analytic + neural residual hybrid operator.
 

Functions

SimResult sim_add_neural_hybrid_operator (struct SimContext *context, const SimNeuralHybridOperatorConfig *config, size_t *out_index)
 Register an analytic-plus-neural residual hybrid operator.
 
SimResult sim_neural_hybrid_config (struct SimContext *context, size_t operator_index, SimNeuralHybridOperatorConfig *out_config)
 Copy the current neural hybrid configuration from a registered operator.
 
SimResult sim_neural_hybrid_update (struct SimContext *context, size_t operator_index, const SimNeuralHybridOperatorConfig *config)
 Replace the configuration of a registered neural hybrid operator.
 

Detailed Description

Analytic+residual neural hybrid operator scaffolding.

Function Documentation

◆ sim_add_neural_hybrid_operator()

SimResult sim_add_neural_hybrid_operator ( struct SimContext context,
const SimNeuralHybridOperatorConfig config,
size_t *  out_index 
)

Register an analytic-plus-neural residual hybrid operator.

Parameters
contextSimulation context that will own the operator.
configOptional hybrid configuration; NULL selects normalized defaults.
[out]out_indexOptional destination for the registered operator index.
Returns
SIM_RESULT_OK on success, or an error code from argument validation, field compatibility checks, allocation, or split registration.

◆ sim_neural_hybrid_config()

SimResult sim_neural_hybrid_config ( struct SimContext context,
size_t  operator_index,
SimNeuralHybridOperatorConfig out_config 
)

Copy the current neural hybrid configuration from a registered operator.

Parameters
contextSimulation context containing the operator.
operator_indexIndex returned by sim_add_neural_hybrid_operator().
[out]out_configReceives the normalized configuration.
Returns
SIM_RESULT_OK on success, SIM_RESULT_INVALID_ARGUMENT for NULL pointers, SIM_RESULT_NOT_FOUND for a missing operator, or SIM_RESULT_INVALID_STATE when the operator has no hybrid state.

◆ sim_neural_hybrid_update()

SimResult sim_neural_hybrid_update ( struct SimContext context,
size_t  operator_index,
const SimNeuralHybridOperatorConfig config 
)

Replace the configuration of a registered neural hybrid operator.

config is required. The replacement is normalized and field/shape compatibility is checked before storing it.

Parameters
contextSimulation context containing the operator.
operator_indexIndex of the neural hybrid operator to update.
configReplacement hybrid configuration.
Returns
SIM_RESULT_OK on success, or an error code from argument validation, lookup, field compatibility checks, or state validation.