datafun.hpp

Go to the documentation of this file.

// src/builtin/include/nk/builtin/datafun.hpp
//
// Pure C++ Data analysis, reductions, random number generation, set operations.
#pragma once
 
#include <memory_resource>
#include <string>
#include <tuple>
#include <nk/value/value.hpp>
#include <nk/ops/rng.hpp>
 
namespace nk::builtin {

 
 
using ::nk::ops::RngContext;
using ::nk::ops::rand;
using ::nk::ops::randn;
using ::nk::ops::randND;
using ::nk::ops::randnND;
using ::nk::ops::randi;
using ::nk::ops::randperm;

 
// ── Reductions ──────────────────────────────────────────────────────────────
 
// ── Reductions ──────────────────────────────────────────────────────────────

Value sum(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value sum(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value prod(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value prod(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value mean(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value mean(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> max(const Value &x, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> max(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value max(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> maxOmitNan(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value maxOmitNanBinary(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> min(const Value &x, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> min(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value min(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> minOmitNan(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value minOmitNanBinary(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr);

Value cumsum(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value cumsum(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value cumprod(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value cumprod(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value cummax(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value cummax(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value cummin(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value cummin(const Value &x, int dim, std::pmr::memory_resource *mr = nullptr);

Value diff(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value diff(const Value &x, int n, int dim = 0, std::pmr::memory_resource *mr = nullptr);

Value anyOf(const Value &x, int dim = 0, std::pmr::memory_resource *mr = nullptr);

Value allOf(const Value &x, int dim = 0, std::pmr::memory_resource *mr = nullptr);
 
// ── Random Number Generation ────────────────────────────────────────────────
// See RngContext-taking declarations re-exported at header top.

enum class HistBinMethod {
    Auto,
    Scott,
    Fd,
    Integers,
    Sturges,
    Sqrt
};

enum class HistNorm {
    Count,
    Probability,
    CountDensity,
    Pdf,
    CumCount,
    Cdf
};

struct HistBinSpec {
    HistBinMethod method = HistBinMethod::Auto;
    bool hasNumBins = false;
    double numBins = 0.0;
    bool hasBinWidth = false;
    double binWidth = 0.0;
    bool hasBinLimits = false;
    double limLo = 0.0;
    double limHi = 0.0;
};
 
// ── Set Operations & Discrete Analysis ──────────────────────────────────────

Value unique(const Value &x, std::pmr::memory_resource *mr = nullptr, bool stable = false);

Value uniqueRows(const Value &x, std::pmr::memory_resource *mr = nullptr, bool stable = false);

std::tuple<Value, Value, Value> uniqueWithIndices(const Value &x, std::pmr::memory_resource *mr = nullptr, bool stable = false, bool last = false);

std::tuple<Value, Value, Value> uniqueRowsWithIndices(const Value &x, std::pmr::memory_resource *mr = nullptr, bool stable = false, bool last = false);

Value ismember(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr);

std::pair<Value, Value> ismemberComplex(const Value &a, const Value &b, bool wantLoc, std::pmr::memory_resource *mr);

Value setUnion(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr, bool stable = false);

Value setIntersect(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr, bool stable = false);

Value setDiff(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr, bool stable = false);

Value setxor(const Value &a, const Value &b, std::pmr::memory_resource *mr = nullptr);

Value discretize(const Value &x, const Value &edges, std::pmr::memory_resource *mr = nullptr);

Value histc(const Value &x, const Value &edges, std::pmr::memory_resource *mr = nullptr);

Value histcounts(const Value &x, const Value &edges, std::pmr::memory_resource *mr = nullptr);

Value histcounts(const Value &x, const Value &edges, HistNorm norm, std::pmr::memory_resource *mr = nullptr);

Value histcountsAutoEdges(const Value &x, const HistBinSpec &spec, std::pmr::memory_resource *mr = nullptr);

Value allunique(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value numunique(const Value &x, std::pmr::memory_resource *mr = nullptr);

Value ismembertol(const Value &a, const Value &s, double tol = 1e-6, std::pmr::memory_resource *mr = nullptr);

Value uniquetol(const Value &x, double tol = 1e-6, std::pmr::memory_resource *mr = nullptr);
 
// ── Grouping Operations ─────────────────────────────────────────────────────

struct FindgroupsResult {
    Value G;   
    Value ID;  
};

FindgroupsResult findgroups(const Value &g, std::pmr::memory_resource *mr = nullptr);

struct GroupcountsResult {
    Value C;   
    Value GR;  
    Value P;   
};

GroupcountsResult groupcounts(const Value &g, std::pmr::memory_resource *mr = nullptr);

struct GroupsummaryResult {
    Value B;   
    Value BG;  
    Value BC;  
};

GroupsummaryResult groupsummary(const Value &A, const Value &G,
                                const std::string &method,
                                std::pmr::memory_resource *mr = nullptr);

Value grouptransform(const Value &A, const Value &G,
                     const std::string &method,
                     std::pmr::memory_resource *mr = nullptr);

enum class AccumReducer {
    Sum,   
    Max,   
    Min,   
    Prod,  
    Mean,  
    Any,   
    All    
};

Value accumarray(const Value &subs, const Value &vals, Span<const size_t> outShape,
                 AccumReducer op = AccumReducer::Sum, double fillVal = 0.0,
                 std::pmr::memory_resource *mr = nullptr);
 

} // namespace nk::builtin