strfun.hpp

Go to the documentation of this file.

// src/builtin/include/nk/builtin/strfun.hpp
//
// Pure C++ String and character array manipulation functions (MATLAB parity).
#pragma once
 
#include <memory_resource>
#include <string>
#include <nk/value/value.hpp>
#include <nk/value/span.hpp>
 
namespace nk::builtin {

 

 
// ── Conversion & Construction ───────────────────────────────────────────────

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

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

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

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

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

Value str2num(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value str2double(const Value &s, std::pmr::memory_resource *mr = nullptr);

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

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

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

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

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

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

Value newlineFn(std::pmr::memory_resource *mr = nullptr);
 
// ── Comparison ─────────────────────────────────────────────────────────────

Value strcmp(const Value &s1, const Value &s2, std::pmr::memory_resource *mr = nullptr);

Value strncmp(const Value &s1, const Value &s2, size_t n, std::pmr::memory_resource *mr = nullptr);

Value strcmpi(const Value &s1, const Value &s2, std::pmr::memory_resource *mr = nullptr);

Value strncmpi(const Value &s1, const Value &s2, size_t n, std::pmr::memory_resource *mr = nullptr);

Value matches(const Value &str, const Value &pat, std::pmr::memory_resource *mr = nullptr);
 
// ── Case & Trimming ─────────────────────────────────────────────────────────

Value upper(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value lower(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value strtrim(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value deblank(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value strip(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value strip(const Value &s, const Value &side, const Value &ch, std::pmr::memory_resource *mr = nullptr);
 
// ── Joining & Splitting ─────────────────────────────────────────────────────

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

Value strjoin(const Value &c, const std::string &delim = " ", std::pmr::memory_resource *mr = nullptr);

Value strjoin(const Value &arr, const Value &delim, std::pmr::memory_resource *mr = nullptr);

Value join(const Value &arr, const Value &delim = Value::Empty, std::pmr::memory_resource *mr = nullptr);

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

Value strsplit(const Value &s, const std::string &delim = " ", std::pmr::memory_resource *mr = nullptr);

Value strsplit(const Value &s, const Value &delim, std::pmr::memory_resource *mr = nullptr);

Value strsplit(const Value &s, std::pmr::memory_resource *mr);

Value split(const Value &s, const Value &delim = Value::Empty, std::pmr::memory_resource *mr = nullptr);

Value splitlines(const Value &s, std::pmr::memory_resource *mr = nullptr);
 
// ── Search & Replace ────────────────────────────────────────────────────────

Value strfind(const Value &text, const Value &pattern, std::pmr::memory_resource *mr = nullptr);

Value strrep(const Value &orig, const Value &oldStr, const Value &newStr, std::pmr::memory_resource *mr = nullptr);

Value contains(const Value &str, const Value &pat, bool ignoreCase = false, std::pmr::memory_resource *mr = nullptr);

Value startsWith(const Value &str, const Value &pat, bool ignoreCase = false, std::pmr::memory_resource *mr = nullptr);

Value endsWith(const Value &str, const Value &pat, bool ignoreCase = false, std::pmr::memory_resource *mr = nullptr);

Value strlength(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value count(const Value &str, const Value &pat, std::pmr::memory_resource *mr = nullptr);

Value reverse(const Value &str, std::pmr::memory_resource *mr = nullptr);

Value erase(const Value &s, const Value &pat, std::pmr::memory_resource *mr = nullptr);

Value replace(const Value &s, const Value &oldPat, const Value &newPat, std::pmr::memory_resource *mr = nullptr);

Value replaceBetween(const Value &s, const Value &start, const Value &end, const Value &newText, std::pmr::memory_resource *mr = nullptr);

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

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

Value extractBetween(const Value &s, const Value &start, const Value &end, std::pmr::memory_resource *mr = nullptr);

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

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

Value eraseBetween(const Value &s, const Value &start, const Value &end, std::pmr::memory_resource *mr = nullptr);

Value extract(const Value &s, const Value &pat, std::pmr::memory_resource *mr = nullptr);

Value pad(const Value &s, size_t n, const Value &side = Value(), const Value &padChar = Value(), std::pmr::memory_resource *mr = nullptr);

Value strjust(const Value &M, const std::string &side = "left", std::pmr::memory_resource *mr = nullptr);
 
// ── Classification & Validation ─────────────────────────────────────────────

Value isletter(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value isspace(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value isspaceFn(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value isstrprop(const Value &s, const std::string &category, std::pmr::memory_resource *mr = nullptr);

Value isstrprop(const Value &s, const Value &category, std::pmr::memory_resource *mr = nullptr);

Value isstringscalar(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value validatestring(const Value &str, const Value &validStrings, std::pmr::memory_resource *mr = nullptr);

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

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

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

Value stringsND(Span<const size_t> dims, std::pmr::memory_resource *mr = nullptr);
 
// ── Base & Hex Conversions ──────────────────────────────────────────────────

Value dec2bin(const Value &d, int minDigits = 0, std::pmr::memory_resource *mr = nullptr);

Value dec2hex(const Value &d, int minDigits = 0, std::pmr::memory_resource *mr = nullptr);

Value dec2base(const Value &d, int base, int minDigits = 0, std::pmr::memory_resource *mr = nullptr);

Value base2dec(const Value &s, int base, std::pmr::memory_resource *mr = nullptr);

Value bin2dec(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value hex2dec(const Value &s, std::pmr::memory_resource *mr = nullptr);

Value hex2num(const Value &s, std::pmr::memory_resource *mr = nullptr);

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

Value rat(const Value &x, double tol = 0.0, std::pmr::memory_resource *mr = nullptr);

Value rats(const Value &x, int len = 13, std::pmr::memory_resource *mr = nullptr);

std::pair<Value, Value> strtok(const Value &str, const std::string &delim = " \t\n\r", std::pmr::memory_resource *mr = nullptr);
 
// ── Regular Expressions ─────────────────────────────────────────────────────

Value regexp(const Value &str, const Value &pat, std::pmr::memory_resource *mr = nullptr);

Value regexpi(const Value &str, const Value &pat, std::pmr::memory_resource *mr = nullptr);

Value regexpFind(const Value &s, const Value &pat, const std::string &option, bool ignoreCase, std::pmr::memory_resource *mr = nullptr);

Value regexpFindOnce(const Value &s, const Value &pat, const std::string &option, bool ignoreCase, std::pmr::memory_resource *mr = nullptr);

Value regexprep(const Value &str, const Value &pat, const Value &rep, bool ignoreCase = false, bool once = false, std::pmr::memory_resource *mr = nullptr);

Value regexptranslate(const std::string &type, const std::string &str, std::pmr::memory_resource *mr = nullptr);

Value regexptranslate(const std::string &type, const Value &str, std::pmr::memory_resource *mr = nullptr);

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

std::string formatOnce(const std::string &fmt, Span<const Value> args, size_t argStart = 0, bool literalWhenShort = false);

std::string formatCyclic(const std::string &fmt, Span<const Value> args, size_t argStart = 0, std::pmr::memory_resource *mr = nullptr);

size_t countFormatSpecs(const std::string &fmt);

std::string dispFormat(const Value &a);
 

} // namespace nk::builtin