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

Complex-plane slice stimulus for Zeta/Xi visualization. More...

#include "oakfield/operator_split.h"
#include "oakfield/plane_chart.h"
#include <stdbool.h>
#include <stddef.h>
Include dependency graph for zeta_plane_slice.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SimStimulusZetaPlaneSliceConfig
 Configuration for sampling zeta or xi over a charted complex-plane slice. More...
 

Typedefs

typedef enum SimStimulusZetaPlaneSliceFamily SimStimulusZetaPlaneSliceFamily
 Special-function family sampled by the complex-plane slice stimulus.
 
typedef enum SimStimulusZetaPlaneSliceViewMode SimStimulusZetaPlaneSliceViewMode
 Scalar projection extracted from sampled Zeta/Xi values.
 
typedef enum SimStimulusZetaPlaneSliceRenderMode SimStimulusZetaPlaneSliceRenderMode
 Accuracy/performance mode for zeta-plane sampling.
 
typedef struct SimStimulusZetaPlaneSliceConfig SimStimulusZetaPlaneSliceConfig
 Configuration for sampling zeta or xi over a charted complex-plane slice.
 

Enumerations

enum  SimStimulusZetaPlaneSliceFamily { SIM_STIMULUS_ZETA_PLANE_SLICE_FAMILY_ZETA = 0 , SIM_STIMULUS_ZETA_PLANE_SLICE_FAMILY_XI = 1 }
 Special-function family sampled by the complex-plane slice stimulus. More...
 
enum  SimStimulusZetaPlaneSliceViewMode {
  SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_RE = 0 , SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_IM , SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_ABS , SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_LOG_ABS ,
  SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_ARG
}
 Scalar projection extracted from sampled Zeta/Xi values. More...
 
enum  SimStimulusZetaPlaneSliceRenderMode { SIM_STIMULUS_ZETA_PLANE_SLICE_RENDER_EXACT = 0 , SIM_STIMULUS_ZETA_PLANE_SLICE_RENDER_INTERACTIVE }
 Accuracy/performance mode for zeta-plane sampling. More...
 

Functions

SimResult sim_add_stimulus_zeta_plane_slice_operator (struct SimContext *context, const SimStimulusZetaPlaneSliceConfig *config, size_t *out_index)
 Register a Zeta/Xi complex-plane slice stimulus operator.
 
SimResult sim_stimulus_zeta_plane_slice_config (struct SimContext *context, size_t operator_index, SimStimulusZetaPlaneSliceConfig *out_config)
 Copy the current Zeta-plane slice configuration from a registered operator.
 
SimResult sim_stimulus_zeta_plane_slice_update (struct SimContext *context, size_t operator_index, const SimStimulusZetaPlaneSliceConfig *config)
 Replace or renormalize a registered Zeta-plane slice configuration.
 

Detailed Description

Complex-plane slice stimulus for Zeta/Xi visualization.

Samples either zeta(s) or xi(s) over a rectangular window in the complex plane and writes a scalar projection of the sampled value into the target field. The window is parameterized by the center sigma_center + i t_center and spans sigma_span by t_span.

This operator uses the supported Zeta/Xi evaluators. Render-mode defaults, sampling heuristics, and visual output may evolve as the visualization surface is refined.

Enumeration Type Documentation

◆ SimStimulusZetaPlaneSliceFamily

Special-function family sampled by the complex-plane slice stimulus.

Enumerator
SIM_STIMULUS_ZETA_PLANE_SLICE_FAMILY_ZETA 

Sample the Riemann zeta function.

SIM_STIMULUS_ZETA_PLANE_SLICE_FAMILY_XI 

Sample the completed xi function.

◆ SimStimulusZetaPlaneSliceRenderMode

Accuracy/performance mode for zeta-plane sampling.

Enumerator
SIM_STIMULUS_ZETA_PLANE_SLICE_RENDER_EXACT 

Use exact/high-accuracy context.

SIM_STIMULUS_ZETA_PLANE_SLICE_RENDER_INTERACTIVE 

Use relaxed interactive context.

◆ SimStimulusZetaPlaneSliceViewMode

Scalar projection extracted from sampled Zeta/Xi values.

Enumerator
SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_RE 

Real component.

SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_IM 

Imaginary component.

SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_ABS 

Magnitude.

SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_LOG_ABS 

Log magnitude.

SIM_STIMULUS_ZETA_PLANE_SLICE_VIEW_ARG 

Phase angle.

Function Documentation

◆ sim_add_stimulus_zeta_plane_slice_operator()

SimResult sim_add_stimulus_zeta_plane_slice_operator ( struct SimContext context,
const SimStimulusZetaPlaneSliceConfig config,
size_t *  out_index 
)

Register a Zeta/Xi complex-plane slice stimulus operator.

The implementation copies and normalizes config, prepares the plane chart, and registers a scalar projection of the sampled analytic family.

Parameters
contextSimulation context that will own the operator.
configOptional zeta-plane 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 validation, allocation, runtime setup, or split-operator registration.

◆ sim_stimulus_zeta_plane_slice_config()

SimResult sim_stimulus_zeta_plane_slice_config ( struct SimContext context,
size_t  operator_index,
SimStimulusZetaPlaneSliceConfig out_config 
)

Copy the current Zeta-plane slice configuration from a registered operator.

Parameters
contextSimulation context containing the operator.
operator_indexIndex returned by sim_add_stimulus_zeta_plane_slice_operator().
[out]out_configReceives 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_zeta_plane_slice_update()

SimResult sim_stimulus_zeta_plane_slice_update ( struct SimContext context,
size_t  operator_index,
const SimStimulusZetaPlaneSliceConfig config 
)

Replace or renormalize a registered Zeta-plane slice configuration.

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

Parameters
contextSimulation context containing the operator.
operator_indexIndex of the zeta-plane slice operator to update.
configOptional replacement configuration.
Returns
SIM_RESULT_OK on success, or an error code if lookup, runtime setup, or state validation fails.