posenc.h File Reference

NeRF-style positional encoding stimulus. More...

#include "coords.h"
#include "oakfield/operator_split.h"
#include <stdbool.h>
#include <stddef.h>

Include dependency graph for posenc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SimStimulusPosEncConfig
	Configuration for NeRF-style positional encoding stimulus bands. More...

Typedefs
typedef struct SimStimulusPosEncConfig	SimStimulusPosEncConfig
	Configuration for NeRF-style positional encoding stimulus bands.

Functions
SimResult	sim_add_stimulus_posenc_operator (struct SimContext *context, const SimStimulusPosEncConfig *config, size_t *out_index)
	Register a positional-encoding stimulus operator.
SimResult	sim_stimulus_posenc_config (struct SimContext *context, size_t operator_index, SimStimulusPosEncConfig *out_config)
	Copy the current positional-encoding configuration from a registered operator.
SimResult	sim_stimulus_posenc_update (struct SimContext *context, size_t operator_index, const SimStimulusPosEncConfig *config)
	Replace or renormalize a registered positional-encoding configuration.

Detailed Description

NeRF-style positional encoding stimulus.

Encodes coordinates with dyadic Fourier bands and injects the summed embedding: e(u, t) = [optional u] + sum_l cos(k_l u - omega t + phase) + i sin(...) where k_l = base_wavenumber * band_growth^l.

Function Documentation

sim_add_stimulus_posenc_operator()

SimResult sim_add_stimulus_posenc_operator	(	struct SimContext *	context,
		const SimStimulusPosEncConfig *	config,
		size_t *	out_index
	)

Register a positional-encoding stimulus operator.

The implementation copies and normalizes config, then registers a split operator that sums the configured Fourier encoding bands on the target field.

Parameters

	context	Simulation context that will own the operator.
	config	Optional positional-encoding configuration; NULL selects normalized defaults.
[out]	out_index	Optional destination for the registered operator index.

Returns

SIM_RESULT_OK on success, or an error code from validation, allocation, buffer setup, or split-operator registration.

sim_stimulus_posenc_config()

SimResult sim_stimulus_posenc_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusPosEncConfig *	out_config
	)

Copy the current positional-encoding configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_stimulus_posenc_operator().
[out]	out_config	Receives the operator's 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 stimulus state.

sim_stimulus_posenc_update()

SimResult sim_stimulus_posenc_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusPosEncConfig *	config
	)

Replace or renormalize a registered positional-encoding configuration.

Passing NULL for config keeps the existing configuration and reapplies normalization. A successful update refreshes symbolic state and invalidates the scheduler plan.

Parameters

context	Simulation context containing the operator.
operator_index	Index of the positional-encoding operator to update.
config	Optional replacement configuration.

Returns

SIM_RESULT_OK on success, or an error code if lookup, buffer setup, or state validation fails.