multifractal.h File Reference

Multiplicative multifractal stimulus built from centered octave products. More...

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

Include dependency graph for multifractal.h:

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

Go to the source code of this file.

Classes
struct	SimStimulusMultifractalConfig
	Configuration for seeded multiplicative multifractal stimulus noise. More...

Typedefs
typedef struct SimStimulusMultifractalConfig	SimStimulusMultifractalConfig
	Configuration for seeded multiplicative multifractal stimulus noise.

Functions
SimResult	sim_add_stimulus_multifractal_operator (struct SimContext *context, const SimStimulusMultifractalConfig *config, size_t *out_index)
	Register a multiplicative multifractal stimulus operator.
SimResult	sim_stimulus_multifractal_config (struct SimContext *context, size_t operator_index, SimStimulusMultifractalConfig *out_config)
	Copy the current multifractal configuration from a registered operator.
SimResult	sim_stimulus_multifractal_update (struct SimContext *context, size_t operator_index, const SimStimulusMultifractalConfig *config)
	Replace or renormalize a registered multifractal stimulus configuration.

Detailed Description

Multiplicative multifractal stimulus built from centered octave products.

Synthesizes multiplicative fractal noise using a seeded multi-octave cosine basis: M(x) = prod_o (1 + 0.5 * lambda^{-H o} * cos(2*pi*lambda^o*x + phi_o)) - 1.

For complex fields, the imaginary channel uses the corresponding centered multiplicative product of the sine basis.

Function Documentation

sim_add_stimulus_multifractal_operator()

SimResult sim_add_stimulus_multifractal_operator	(	struct SimContext *	context,
		const SimStimulusMultifractalConfig *	config,
		size_t *	out_index
	)

Register a multiplicative multifractal stimulus operator.

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

Parameters

	context	Simulation context that will own the operator.
	config	Optional multifractal 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_multifractal_config()

SimResult sim_stimulus_multifractal_config	(	struct SimContext *	context,
		size_t	operator_index,
		SimStimulusMultifractalConfig *	out_config
	)

Copy the current multifractal configuration from a registered operator.

Parameters

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

SimResult sim_stimulus_multifractal_update	(	struct SimContext *	context,
		size_t	operator_index,
		const SimStimulusMultifractalConfig *	config
	)

Replace or renormalize a registered multifractal 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 multifractal 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.