jm object NAME --preset consumer — consumer (input → ())¶

A consumer takes input but produces no output — step() accepts a sample and returns nothing; state carries whatever the algorithm accumulates. The user reads the result by inspecting state via getters or a dedicated method.

Concrete examples: a running mean / variance accumulator, an integrator, a checksum, a histogram bin counter, a log-line writer that flushes to disk, a metric reporter that ships samples to a stats system, or any "fold" over an incoming stream.

--preset consumer expands to --return-type void, which strips the output side of step(). The scaffold builds and tests green straight away.

Command¶

jm object NAME --preset consumer \
    --arg-type "float _Complex" \
    --state count:uint64_t:0 \
    --state sum:double:0.0

What you get¶

native/inc/NAME/NAME_core.h¶

typedef struct {
    uint64_t count;
    double   sum;
} NAME_state_t;

NAME_state_t *NAME_create(uint64_t count, double sum);
void          NAME_destroy(NAME_state_t *state);
void          NAME_reset(NAME_state_t *state);

/* Per-sample consumer. */
static inline void
NAME_step(NAME_state_t *state, float complex x);

/* Block consumer. */
void NAME_steps(NAME_state_t *state, const float complex *in, size_t n);

/* Generic accessor to read accumulated state. */
double NAME_get_sum(const NAME_state_t *state);
uint64_t NAME_get_count(const NAME_state_t *state);

native/src/NAME/NAME_core.c¶

static inline void
NAME_step(NAME_state_t *state, float complex x)
{
    /* TODO: update internal state. The default body accumulates
       |x|^2 and increments a counter — replace with your reducer. */
    state->sum += (double)(crealf(x) * crealf(x) + cimagf(x) * cimagf(x));
    state->count++;
}

void
NAME_steps(NAME_state_t *state, const float complex *in, size_t n)
{
    for (size_t i = 0; i < n; i++) NAME_step(state, in[i]);
}

What you fill in¶

The reducer in step(). Common shapes:

• Running sum / mean / RMS.
• Histogram bin update.
• Threshold counter ("how many samples above X?").
• Direct write to a file descriptor stored in state.

Python usage¶

import numpy as np
from <pkg> import NAME

acc = NAME(count=0, sum=0.0)
acc.steps(np.ones(1024, dtype=np.complex64))
print(acc.get_sum(), acc.get_count())

Concrete types¶

Generated accessors (get_sum, get_count, etc.) follow the standard State variable types NumPy mapping.