elmat.hpp

Go to the documentation of this file.

// src/builtin/include/nk/builtin/elmat.hpp
//
// Pure C++ Elementary matrices and array manipulation functions (MATLAB parity).
#pragma once
 
#include <memory_resource>
#include <string>
#include <tuple>
#include <vector>
#include <nk/value/value.hpp>
#include <nk/value/span.hpp>
 
namespace nk::builtin {

 

 
// ── Multi-value Return Types ───────────────────────────────────────────────

using Meshgrid2D = std::tuple<Value, Value>;

using Meshgrid3D = std::tuple<Value, Value, Value>;
 
// ── Array Creation ──────────────────────────────────────────────────────────

Value zeros(Span<const size_t> dims, ValueType dtype = ValueType::DOUBLE, std::pmr::memory_resource *mr = nullptr);

Value zeros(size_t rows, size_t cols, ValueType dtype = ValueType::DOUBLE, std::pmr::memory_resource *mr = nullptr);

Value ones(Span<const size_t> dims, ValueType dtype = ValueType::DOUBLE, std::pmr::memory_resource *mr = nullptr);

Value ones(size_t rows, size_t cols, ValueType dtype = ValueType::DOUBLE, std::pmr::memory_resource *mr = nullptr);

Value eye(size_t n, std::pmr::memory_resource *mr = nullptr);

Value eye(size_t m, size_t n, std::pmr::memory_resource *mr = nullptr);

Value eye(size_t n, ValueType dtype, std::pmr::memory_resource *mr = nullptr);

Value eye(size_t m, size_t n, ValueType dtype, std::pmr::memory_resource *mr = nullptr);

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

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

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

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

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

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

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

Value peaks(size_t n = 49, std::pmr::memory_resource *mr = nullptr);

Value linspace(double a, double b, size_t n = 100, std::pmr::memory_resource *mr = nullptr);

Value logspace(double a, double b, size_t n = 50, std::pmr::memory_resource *mr = nullptr);

Value magic(size_t n, std::pmr::memory_resource *mr = nullptr);

Value hilb(size_t n, std::pmr::memory_resource *mr = nullptr);

Value invhilb(size_t n, std::pmr::memory_resource *mr = nullptr);

Value pascal(size_t n, std::pmr::memory_resource *mr = nullptr);

Value pascal(size_t n, int k, std::pmr::memory_resource *mr = nullptr);

Value toeplitz(const Value &c, const Value &r = Value(), std::pmr::memory_resource *mr = nullptr);

Value vander(const Value &v, std::pmr::memory_resource *mr = nullptr);

Value wilkinson(size_t n, std::pmr::memory_resource *mr = nullptr);

Value rosser(std::pmr::memory_resource *mr = nullptr);

Value hadamard(size_t n, std::pmr::memory_resource *mr = nullptr);

Value hankel(const Value &c, const Value &r = Value(), std::pmr::memory_resource *mr = nullptr);

Value compan(const Value &p, std::pmr::memory_resource *mr = nullptr);

struct Surface3 {
    Value X;  
    Value Y;  
    Value Z;  
};

Surface3 sphere(size_t n = 20, std::pmr::memory_resource *mr = nullptr);

Surface3 cylinder(const Value &R, size_t n = 20, std::pmr::memory_resource *mr = nullptr);

Surface3 ellipsoid(double xc, double yc, double zc, double xr, double yr, double zr, size_t n = 20, std::pmr::memory_resource *mr = nullptr);

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

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

Meshgrid3D meshgrid(const Value &x, const Value &y, const Value &z, std::pmr::memory_resource *mr = nullptr);

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

Meshgrid3D ndgrid(const Value &x, const Value &y, const Value &z, std::pmr::memory_resource *mr = nullptr);
 
// ── Array Manipulation & Reshaping ──────────────────────────────────────────

Value repmat(const Value &x, Span<const size_t> reps, std::pmr::memory_resource *mr = nullptr);

Value repmat(const Value &x, size_t r, size_t c, std::pmr::memory_resource *mr = nullptr);

Value repmat(const Value &x, size_t r, size_t c, size_t p, std::pmr::memory_resource *mr = nullptr);

Value repmatND(const Value &x, Span<const size_t> tiles, std::pmr::memory_resource *mr = nullptr);

Value repelem(const Value &x, Span<const size_t> reps, std::pmr::memory_resource *mr = nullptr);

Value reshape(const Value &x, Span<const size_t> newDims, std::pmr::memory_resource *mr = nullptr);

Value reshape(const Value &x, size_t rows, size_t cols, size_t pages = 0, std::pmr::memory_resource *mr = nullptr);

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

Value blkdiag(Span<const Value> matrices, std::pmr::memory_resource *mr = nullptr);

Value cat(int dim, Span<const Value> arrays, std::pmr::memory_resource *mr = nullptr);

Value horzcat(Span<const Value> arrays, std::pmr::memory_resource *mr = nullptr);

Value vertcat(Span<const Value> arrays, std::pmr::memory_resource *mr = nullptr);

Value rot90(const Value &x, int k = 1, std::pmr::memory_resource *mr = nullptr);

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

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

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

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

Value circshift(const Value &x, int64_t kRow, int64_t kCol, std::pmr::memory_resource *mr = nullptr);

Value circshift(const Value &x, Span<const int64_t> shifts, std::pmr::memory_resource *mr = nullptr);

Value circshiftND(const Value &x, Span<const int64_t> shifts, std::pmr::memory_resource *mr = nullptr);

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

Value repelem(const Value &x, size_t m, size_t n, std::pmr::memory_resource *mr = nullptr);

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

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

Value permute(const Value &x, Span<const int> order, std::pmr::memory_resource *mr = nullptr);

Value permute(const Value &x, Span<const size_t> order, std::pmr::memory_resource *mr = nullptr);

Value ipermute(const Value &x, Span<const int> order, std::pmr::memory_resource *mr = nullptr);

Value ipermute(const Value &x, Span<const size_t> order, std::pmr::memory_resource *mr = nullptr);

struct ShiftDimAuto {
    Value v;          
    int dropped = 0;  
};

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

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

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

Value head(const Value &x, size_t k = 8, std::pmr::memory_resource *mr = nullptr);

Value tail(const Value &x, size_t k = 8, std::pmr::memory_resource *mr = nullptr);

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

Value paddata(const Value &x, size_t len, int dim, const std::string &side = "right", std::pmr::memory_resource *mr = nullptr);

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

Value trimdata(const Value &x, size_t len, int dim, const std::string &side = "right", std::pmr::memory_resource *mr = nullptr);

Value resize(const Value &v, size_t n, std::pmr::memory_resource *mr = nullptr);

Value sub2ind(const Value &siz, Span<const Value> subs, std::pmr::memory_resource *mr = nullptr);

std::vector<Value> ind2sub(const Value &siz, const Value &ind, size_t nout = 0, std::pmr::memory_resource *mr = nullptr);

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

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

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

enum class NanPlace {
    Auto,   
    First,  
    Last    
};

std::tuple<Value, Value> sort(const Value &x, int dim = 0, bool descend = false, NanPlace nanPlace = NanPlace::Auto, std::pmr::memory_resource *mr = nullptr);

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

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

std::tuple<Value, Value> sortrows(const Value &x, Span<const int> cols, Span<const bool> desc, std::pmr::memory_resource *mr = nullptr);

Value issorted(const Value &x, int dim = 0, bool descend = false, std::pmr::memory_resource *mr = nullptr);

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

Value issortedrows(const Value &x, Span<const int> cols, Span<const bool> desc = {}, std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value> topkrows(const Value &x, size_t k, Span<const int> cols = {}, Span<const bool> desc = {}, std::pmr::memory_resource *mr = nullptr);

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

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

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

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

} // namespace nk::builtin