hybrid_fbm.h File Reference

Hybrid fBm stimulus with octave-to-octave cascade weighting. More...

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

Include dependency graph for hybrid_fbm.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusHybridFbmConfig
	Configuration for seeded hybrid fractional Brownian motion stimulus noise. More...

Typedefs
typedef struct SimStimulusHybridFbmConfig	SimStimulusHybridFbmConfig
	Configuration for seeded hybrid fractional Brownian motion stimulus noise.

Functions
SimResult	sim_add_stimulus_hybrid_fbm_operator (struct SimContext *context, const SimStimulusHybridFbmConfig *config, size_t *out_index)
	Register a hybrid fBm stimulus operator.
SimResult	sim_stimulus_hybrid_fbm_config (struct SimContext *context, size_t operator_index, SimStimulusHybridFbmConfig *out_config)
	Copy the current hybrid fBm configuration from a registered operator.
SimResult	sim_stimulus_hybrid_fbm_update (struct SimContext *context, size_t operator_index, const SimStimulusHybridFbmConfig *config)
	Replace or renormalize a registered hybrid fBm stimulus configuration.

Detailed Description

Hybrid fBm stimulus with octave-to-octave cascade weighting.

Synthesizes hybrid fractal noise using a seeded multi-octave cosine basis where each octave modulates the next through a bounded weight cascade.

For complex fields, the imaginary channel uses the corresponding sinusoidal basis with its own bounded cascade.

Function Documentation

sim_add_stimulus_hybrid_fbm_operator()

SimResult sim_add_stimulus_hybrid_fbm_operator	(	struct SimContext *	context,
		const SimStimulusHybridFbmConfig *	config,
		size_t *	out_index
	)

Register a hybrid fBm stimulus operator.

The implementation copies and normalizes config, initializes octave phases from the configured seed, and registers the cascading fractal operator.

Parameters

	context	Simulation context that will own the operator.
	config	Optional hybrid fBm 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, octave setup, or split-operator registration.

sim_stimulus_hybrid_fbm_config()

SimResult sim_stimulus_hybrid_fbm_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusHybridFbmConfig *	out_config
	)

Copy the current hybrid fBm configuration from a registered operator.

Parameters

	context	Simulation context containing the operator.
	operator_index	Index returned by sim_add_stimulus_hybrid_fbm_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_hybrid_fbm_update()

SimResult sim_stimulus_hybrid_fbm_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusHybridFbmConfig *	config
	)

Replace or renormalize a registered hybrid fBm stimulus configuration.

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

Parameters

context	Simulation context containing the operator.
operator_index	Index of the hybrid fBm operator to update.
config	Optional replacement configuration.

Returns

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