Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimOperatorInfo Struct Reference

Metadata describing operator characteristics. More...

#include <operator.h>

Collaboration diagram for SimOperatorInfo:

Public Attributes

SimOperatorCategory category
 
SimWarpLevel warp_level
 
const char * schema_key
 
bool has_ir_opcode
 
SimIROpcode ir_opcode
 
bool is_noise
 
bool is_differentiable
 
bool is_spectral
 
bool is_local
 
bool is_nonlocal
 
bool is_linear
 
bool is_warp
 
bool preserves_real
 
double preferred_dt
 
const char * abstract_id
 
const char *(* abstract_id_fn )(const struct SimOperator *op)
 
uint32_t algebraic_flags
 
SimDeterminismFlags determinism_flags
 
SimOperatorNeuralContract neural
 
SimOperatorRepresentation representation
 
SimOperatorApproximation approximation
 
SimOperatorInvariant invariants [SIM_OPERATOR_MAX_INVARIANTS]
 
uint8_t invariant_count
 

Detailed Description

Metadata describing operator characteristics.

Member Data Documentation

◆ abstract_id

const char* SimOperatorInfo::abstract_id

Optional abstract identifier (functional identity).

◆ abstract_id_fn

const char *(* SimOperatorInfo::abstract_id_fn) (const struct SimOperator *op)

Callback to fetch abstract id.

◆ algebraic_flags

uint32_t SimOperatorInfo::algebraic_flags

Bitmask of algebraic properties.

◆ approximation

SimOperatorApproximation SimOperatorInfo::approximation

Approximation order metadata.

◆ category

SimOperatorCategory SimOperatorInfo::category

Operator category.

◆ determinism_flags

SimDeterminismFlags SimOperatorInfo::determinism_flags

Determinism guarantees promised by the operator.

◆ has_ir_opcode

bool SimOperatorInfo::has_ir_opcode

True when core metadata supplied ir_opcode.

◆ invariant_count

uint8_t SimOperatorInfo::invariant_count

Number of invariants populated.

◆ invariants

SimOperatorInvariant SimOperatorInfo::invariants[SIM_OPERATOR_MAX_INVARIANTS]

Declared invariants.

◆ ir_opcode

SimIROpcode SimOperatorInfo::ir_opcode

Core-owned semantic opcode for KernelIR tagging.

◆ is_differentiable

bool SimOperatorInfo::is_differentiable

Whether operator is differentiable (for AD/sensitivity).

◆ is_linear

bool SimOperatorInfo::is_linear

Enables reordering optimizations.

◆ is_local

bool SimOperatorInfo::is_local

Stencil or pointwise operator.

◆ is_noise

bool SimOperatorInfo::is_noise

Whether operator involves randomness.

◆ is_nonlocal

bool SimOperatorInfo::is_nonlocal

Convolution, diffusion, or other nonlocal operator.

◆ is_spectral

bool SimOperatorInfo::is_spectral

Requires FFT/spectral domain.

◆ is_warp

bool SimOperatorInfo::is_warp

Nonlinear transform classified as a warp.

◆ neural

SimOperatorNeuralContract SimOperatorInfo::neural

Neural inference contract metadata.

◆ preferred_dt

double SimOperatorInfo::preferred_dt

Suggested timestep, or 0.0 for no preference.

◆ preserves_real

bool SimOperatorInfo::preserves_real

True if operator keeps real fields real.

◆ representation

SimOperatorRepresentation SimOperatorInfo::representation

Representation hints.

◆ schema_key

const char* SimOperatorInfo::schema_key

Stable identity independent of rich schema metadata.

◆ warp_level

SimWarpLevel SimOperatorInfo::warp_level

Warp classification level.


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