Text composition, formatted string output (sprintf), search, regular expressions, and type conversions. More...

Files
file	strfun.hpp
	String, character vector, and regular expression operations.

Functions
Value	nk::builtin::num2str (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Formats numeric array into character vector (num2str(x)).
Value	nk::builtin::num2str (const Value &x, int N, std::pmr::memory_resource *mr=nullptr)
	Formats numeric array into character vector with specified precision digits (num2str(x, N)).
Value	nk::builtin::num2str (const Value &x, const std::string &fmt, std::pmr::memory_resource *mr=nullptr)
	Formats numeric array into character vector with format specification (num2str(x, fmt)).
Value	nk::builtin::int2str (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Formats integer into character vector (int2str(x)).
Value	nk::builtin::mat2str (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Formats matrix into MATLAB syntax string (mat2str(x)).
Value	nk::builtin::mat2str (const Value &x, int precision, std::pmr::memory_resource *mr=nullptr)
	Formats matrix into MATLAB syntax string with precision (mat2str(x, precision)).
Value	nk::builtin::str2num (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Converts string representation to numeric matrix (str2num(s)).
Value	nk::builtin::str2double (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Converts text to double precision numeric values (str2double(s)).
Value	nk::builtin::char_array (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Converts input to character array (char(x)).
Value	nk::builtin::toChar (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Alias for char_array conversion (char(x)).
Value	nk::builtin::string_array (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Converts input to string array (string(x)).
Value	nk::builtin::toString (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Alias for string_array conversion (string(x)).
Value	nk::builtin::blanks (size_t n, std::pmr::memory_resource *mr=nullptr)
	Creates character vector of blank spaces (blanks(n)).
Value	nk::builtin::newline (std::pmr::memory_resource *mr=nullptr)
	Creates newline character string (newline).
Value	nk::builtin::newlineFn (std::pmr::memory_resource *mr=nullptr)
	Generates newline character as string Value.
Value	nk::builtin::strcmp (const Value &s1, const Value &s2, std::pmr::memory_resource *mr=nullptr)
	Compares strings for exact equality (case-sensitive) (strcmp(s1, s2)).
Value	nk::builtin::strncmp (const Value &s1, const Value &s2, size_t n, std::pmr::memory_resource *mr=nullptr)
	Compares first n characters of strings (case-sensitive) (strncmp(s1, s2, n)).
Value	nk::builtin::strcmpi (const Value &s1, const Value &s2, std::pmr::memory_resource *mr=nullptr)
	Compares strings for equality ignoring case (strcmpi(s1, s2)).
Value	nk::builtin::strncmpi (const Value &s1, const Value &s2, size_t n, std::pmr::memory_resource *mr=nullptr)
	Compares first n characters of strings ignoring case (strncmpi(s1, s2, n)).
Value	nk::builtin::matches (const Value &str, const Value &pat, std::pmr::memory_resource *mr=nullptr)
	Tests if strings match pattern (matches(str, pat)).
Value	nk::builtin::upper (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Converts string to uppercase (upper(s)).
Value	nk::builtin::lower (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Converts string to lowercase (lower(s)).
Value	nk::builtin::strtrim (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Removes leading and trailing whitespace (strtrim(s)).
Value	nk::builtin::deblank (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Removes trailing whitespace (deblank(s)).
Value	nk::builtin::strip (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Strips leading and trailing whitespace from string array (strip(s)).
Value	nk::builtin::strip (const Value &s, const Value &side, const Value &ch, std::pmr::memory_resource *mr=nullptr)
	Strips specified characters from side of string array (strip(s, side, ch)).
Value	nk::builtin::strcat (Span< const Value > args, std::pmr::memory_resource *mr=nullptr)
	Concatenates strings horizontally (strcat(s1, s2, ...)).
Value	nk::builtin::strjoin (const Value &c, const std::string &delim=" ", std::pmr::memory_resource *mr=nullptr)
	Joins string array or cell array of strings with delimiter (strjoin(c, delim)).
Value	nk::builtin::strjoin (const Value &arr, const Value &delim, std::pmr::memory_resource *mr=nullptr)
	Joins string array with Value delimiter (strjoin(arr, delim)).
Value	nk::builtin::join (const Value &arr, const Value &delim=Value::Empty, std::pmr::memory_resource *mr=nullptr)
	Combines elements of string array into single string (join(arr, delim)).
Value	nk::builtin::append (Span< const Value > parts, std::pmr::memory_resource *mr=nullptr)
	Appends multiple strings element-wise (append(s1, s2, ...)).
Value	nk::builtin::strsplit (const Value &s, const std::string &delim=" ", std::pmr::memory_resource *mr=nullptr)
	Splits string by delimiter string (strsplit(s, delim)).
Value	nk::builtin::strsplit (const Value &s, const Value &delim, std::pmr::memory_resource *mr=nullptr)
	Splits string by Value delimiter (strsplit(s, delim)).
Value	nk::builtin::strsplit (const Value &s, std::pmr::memory_resource *mr)
	Splits string by whitespace (strsplit(s)).
Value	nk::builtin::split (const Value &s, const Value &delim=Value::Empty, std::pmr::memory_resource *mr=nullptr)
	Splits string array elements by delimiter (split(s, delim)).
Value	nk::builtin::splitlines (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Splits string into separate lines (splitlines(s)).
Value	nk::builtin::strfind (const Value &text, const Value &pattern, std::pmr::memory_resource *mr=nullptr)
	Finds occurrences of substring within string (strfind(text, pattern)).
Value	nk::builtin::strrep (const Value &orig, const Value &oldStr, const Value &newStr, std::pmr::memory_resource *mr=nullptr)
	Replaces occurrences of substring within string (strrep(orig, old, new)).
Value	nk::builtin::contains (const Value &str, const Value &pat, bool ignoreCase=false, std::pmr::memory_resource *mr=nullptr)
	Checks if string contains pattern (contains(str, pat)).
Value	nk::builtin::startsWith (const Value &str, const Value &pat, bool ignoreCase=false, std::pmr::memory_resource *mr=nullptr)
	Checks if string starts with pattern (startsWith(str, pat)).
Value	nk::builtin::endsWith (const Value &str, const Value &pat, bool ignoreCase=false, std::pmr::memory_resource *mr=nullptr)
	Checks if string ends with pattern (endsWith(str, pat)).
Value	nk::builtin::strlength (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Returns number of characters in each string element (strlength(s)).
Value	nk::builtin::count (const Value &str, const Value &pat, std::pmr::memory_resource *mr=nullptr)
	Counts occurrences of pattern in string (count(str, pat)).
Value	nk::builtin::reverse (const Value &str, std::pmr::memory_resource *mr=nullptr)
	Reverses characters in string (reverse(str)).
Value	nk::builtin::erase (const Value &s, const Value &pat, std::pmr::memory_resource *mr=nullptr)
	Erases occurrences of substring pattern from string (erase(s, pat)).
Value	nk::builtin::replace (const Value &s, const Value &oldPat, const Value &newPat, std::pmr::memory_resource *mr=nullptr)
	Replaces substring pattern with new pattern in string array (replace(s, oldPat, newPat)).
Value	nk::builtin::replaceBetween (const Value &s, const Value &start, const Value &end, const Value &newText, std::pmr::memory_resource *mr=nullptr)
	Replaces text between specified start and end boundaries (replaceBetween(s, start, end, newText)).
Value	nk::builtin::extractAfter (const Value &s, const Value &p, std::pmr::memory_resource *mr=nullptr)
	Extracts substrings after specified pattern or position (extractAfter(s, p)).
Value	nk::builtin::extractBefore (const Value &s, const Value &p, std::pmr::memory_resource *mr=nullptr)
	Extracts substrings before specified pattern or position (extractBefore(s, p)).
Value	nk::builtin::extractBetween (const Value &s, const Value &start, const Value &end, std::pmr::memory_resource *mr=nullptr)
	Extracts substrings between specified boundaries (extractBetween(s, start, end)).
Value	nk::builtin::insertAfter (const Value &s, const Value &p, const Value &newText, std::pmr::memory_resource *mr=nullptr)
	Inserts text after specified position or pattern (insertAfter(s, p, newText)).
Value	nk::builtin::insertBefore (const Value &s, const Value &p, const Value &newText, std::pmr::memory_resource *mr=nullptr)
	Inserts text before specified position or pattern (insertBefore(s, p, newText)).
Value	nk::builtin::eraseBetween (const Value &s, const Value &start, const Value &end, std::pmr::memory_resource *mr=nullptr)
	Erases text between specified boundaries (eraseBetween(s, start, end)).
Value	nk::builtin::extract (const Value &s, const Value &pat, std::pmr::memory_resource *mr=nullptr)
	Extracts substring matching pattern (extract(s, pat)).
Value	nk::builtin::pad (const Value &s, size_t n, const Value &side=Value(), const Value &padChar=Value(), std::pmr::memory_resource *mr=nullptr)
	Pads string to fixed length (pad(s, n, side, padChar)).
Value	nk::builtin::strjust (const Value &M, const std::string &side="left", std::pmr::memory_resource *mr=nullptr)
	Justifies character matrix (strjust(M, side)).
Value	nk::builtin::isletter (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Tests if characters are letters (isletter(s)).
Value	nk::builtin::isspace (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Tests if characters are whitespace (isspace(s)).
Value	nk::builtin::isspaceFn (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Tests if characters are whitespace (internal helper returning Value).
Value	nk::builtin::isstrprop (const Value &s, const std::string &category, std::pmr::memory_resource *mr=nullptr)
	Tests if characters have specified string property (isstrprop(s, category)).
Value	nk::builtin::isstrprop (const Value &s, const Value &category, std::pmr::memory_resource *mr=nullptr)
	Tests if characters have specified string property via Value category (isstrprop(s, category)).
Value	nk::builtin::isstringscalar (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Tests if input is a scalar string (isstringscalar(s)).
Value	nk::builtin::validatestring (const Value &str, const Value &validStrings, std::pmr::memory_resource *mr=nullptr)
	Validates text against list of valid strings (validatestring(str, validStrings)).
Value	nk::builtin::convertCharsToStrings (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Converts character arrays in input to string arrays (convertCharsToStrings(x)).
Value	nk::builtin::convertStringsToChars (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Converts string arrays in input to character vectors (convertStringsToChars(x)).
Value	nk::builtin::convertContainedStringsToChars (const Value &v, std::pmr::memory_resource *mr=nullptr)
	Recursively converts all contained strings in cells/structs to character vectors.
Value	nk::builtin::stringsND (Span< const size_t > dims, std::pmr::memory_resource *mr=nullptr)
	Constructs an N-dimensional array of empty strings.
Value	nk::builtin::dec2bin (const Value &d, int minDigits=0, std::pmr::memory_resource *mr=nullptr)
	Decimal to binary string (dec2bin(d, minDigits)).
Value	nk::builtin::dec2hex (const Value &d, int minDigits=0, std::pmr::memory_resource *mr=nullptr)
	Decimal to hexadecimal string (dec2hex(d, minDigits)).
Value	nk::builtin::dec2base (const Value &d, int base, int minDigits=0, std::pmr::memory_resource *mr=nullptr)
	Decimal to base-N string (dec2base(d, base, minDigits)).
Value	nk::builtin::base2dec (const Value &s, int base, std::pmr::memory_resource *mr=nullptr)
	Base-N string to decimal (base2dec(s, base)).
Value	nk::builtin::bin2dec (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Binary string to decimal (bin2dec(s)).
Value	nk::builtin::hex2dec (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Hexadecimal string to decimal (hex2dec(s)).
Value	nk::builtin::hex2num (const Value &s, std::pmr::memory_resource *mr=nullptr)
	Converts 16-character hexadecimal string to IEEE double-precision floating-point number (hex2num(s)).
Value	nk::builtin::num2hex (const Value &x, std::pmr::memory_resource *mr=nullptr)
	Converts double-precision floating-point number to 16-character hexadecimal string (num2hex(x)).
Value	nk::builtin::rat (const Value &x, double tol=0.0, std::pmr::memory_resource *mr=nullptr)
	Rational approximation as fraction / continued fraction (rat(x, tol)).
Value	nk::builtin::rats (const Value &x, int len=13, std::pmr::memory_resource *mr=nullptr)
	Formats numbers as rational string representations (rats(x, len)).
std::pair< Value, Value >	nk::builtin::strtok (const Value &str, const std::string &delim=" \t\n\r", std::pmr::memory_resource *mr=nullptr)
	Extracts first token from character vector up to delimiter ([token, rem] = strtok(str, delim)).
Value	nk::builtin::regexp (const Value &str, const Value &pat, std::pmr::memory_resource *mr=nullptr)
	Regular expression matching (regexp(str, pat)).
Value	nk::builtin::regexpi (const Value &str, const Value &pat, std::pmr::memory_resource *mr=nullptr)
	Case-insensitive regular expression matching (regexpi(str, pat)).
Value	nk::builtin::regexpFind (const Value &s, const Value &pat, const std::string &option, bool ignoreCase, std::pmr::memory_resource *mr=nullptr)
	Regular expression search helper.
Value	nk::builtin::regexpFindOnce (const Value &s, const Value &pat, const std::string &option, bool ignoreCase, std::pmr::memory_resource *mr=nullptr)
	Regular expression search once helper.
Value	nk::builtin::regexprep (const Value &str, const Value &pat, const Value &rep, bool ignoreCase=false, bool once=false, std::pmr::memory_resource *mr=nullptr)
	Regular expression replacement (regexprep(str, pat, rep, ignoreCase, once)).
Value	nk::builtin::regexptranslate (const std::string &type, const std::string &str, std::pmr::memory_resource *mr=nullptr)
	Translates wildcard strings to regular expressions (regexptranslate(type, str)).
Value	nk::builtin::regexptranslate (const std::string &type, const Value &str, std::pmr::memory_resource *mr=nullptr)
	Translates wildcard Value to regular expression (regexptranslate(type, str)).
Value	nk::builtin::compose (const Value &fmt, const Value &x, std::pmr::memory_resource *mr=nullptr)
	Formats data into string array (compose(fmt, x)).
std::string	nk::builtin::formatOnce (const std::string &fmt, Span< const Value > args, size_t argStart=0, bool literalWhenShort=false)
	Formats single pass of format specification.
std::string	nk::builtin::formatCyclic (const std::string &fmt, Span< const Value > args, size_t argStart=0, std::pmr::memory_resource *mr=nullptr)
	Formats cyclic repetition of format specification across array elements.
size_t	nk::builtin::countFormatSpecs (const std::string &fmt)
	Counts number of conversion specifiers in format string.

Detailed Description

Text composition, formatted string output (sprintf), search, regular expressions, and type conversions.

Function Documentation

◆ append()

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

Appends multiple strings element-wise (append(s1, s2, ...)).

Parameters

parts	Span of input string arrays.
mr	Memory resource.

Returns: Element-wise concatenated string array.

◆ base2dec()

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

Base-N string to decimal (base2dec(s, base)).

Parameters

s	Base-N text.
base	Radix base (2 to 36).
mr	Memory resource.

Returns: Decimal double.

See also: dec2base

◆ bin2dec()

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

Binary string to decimal (bin2dec(s)).

Parameters

s	Binary text.
mr	Memory resource.

Returns: Decimal value.

See also: dec2bin

◆ blanks()

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

Creates character vector of blank spaces (blanks(n)).

Parameters

n	Number of spaces.
mr	Memory resource.

Returns: 1 x n character vector containing ASCII space characters.

◆ char_array()

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

Converts input to character array (char(x)).

Parameters

x	Input value (numeric array of codes, cell of strings, etc.).
mr	Memory resource.

Returns: Character array.

See also: string_array, toChar

◆ compose()

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

Formats data into string array (compose(fmt, x)).

Parameters

fmt	Format string.
x	Input arguments.
mr	Memory resource.

Returns: Formatted string array.

◆ contains()

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

Checks if string contains pattern (contains(str, pat)).

Parameters

str	Text to search.
pat	Substring pattern.
ignoreCase	Case-insensitive flag.
mr	Memory resource.

Returns: Logical scalar or array.

See also: startsWith, endsWith, matches

◆ convertCharsToStrings()

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

Converts character arrays in input to string arrays (convertCharsToStrings(x)).

Parameters

x	Input value.
mr	Memory resource.

Returns: Converted string value.

◆ convertContainedStringsToChars()

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

Recursively converts all contained strings in cells/structs to character vectors.

Parameters

v	Container value.
mr	Memory resource.

Returns: Container with strings converted to char vectors.

◆ convertStringsToChars()

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

Converts string arrays in input to character vectors (convertStringsToChars(x)).

Parameters

x	Input value.
mr	Memory resource.

Returns: Converted character array value.

◆ count()

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

Counts occurrences of pattern in string (count(str, pat)).

Parameters

str	Text to search.
pat	Substring pattern.
mr	Memory resource.

Returns: Count of occurrences.

See also: contains, strfind

◆ countFormatSpecs()

size_t nk::builtin::countFormatSpecs ( const std::string & fmt )

Counts number of conversion specifiers in format string.

Parameters

fmt	Format string.

Returns: Count of % conversion specifiers.

◆ deblank()

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

Removes trailing whitespace (deblank(s)).

Parameters

s	Input text.
mr	Memory resource.

Returns: Deblanked text.

See also: strtrim

◆ dec2base()

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

Decimal to base-N string (dec2base(d, base, minDigits)).

Parameters

d	Non-negative integer value(s).
base	Radix base (2 to 36).
minDigits	Minimum digits.
mr	Memory resource.

Returns: Base-N character array.

See also: base2dec

◆ dec2bin()

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

Decimal to binary string (dec2bin(d, minDigits)).

Parameters

d	Non-negative integer value(s).
minDigits	Minimum number of binary digits to output.
mr	Memory resource.

Returns: Character array of binary representations.

See also: bin2dec, dec2hex

◆ dec2hex()

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

Decimal to hexadecimal string (dec2hex(d, minDigits)).

Parameters

d	Non-negative integer value(s).
minDigits	Minimum number of hex digits to output.
mr	Memory resource.

Returns: Character array of hex representations.

See also: hex2dec, dec2bin

◆ endsWith()

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

Checks if string ends with pattern (endsWith(str, pat)).

Parameters

str	Text to search.
pat	Suffix pattern.
ignoreCase	Case-insensitive flag.
mr	Memory resource.

Returns: Logical scalar or array.

See also: startsWith, contains

◆ erase()

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

Erases occurrences of substring pattern from string (erase(s, pat)).

Parameters

s	Input string.
pat	Pattern to erase.
mr	Memory resource.

Returns: String with pattern removed.

◆ eraseBetween()

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

Erases text between specified boundaries (eraseBetween(s, start, end)).

Parameters

s	Original string.
start	1-based start position or pattern.
end	1-based end position or pattern.
mr	Memory resource.

Returns: Modified string.

◆ extract()

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

Extracts substring matching pattern (extract(s, pat)).

Parameters

s	Input string.
pat	Pattern to extract.
mr	Memory resource.

Returns: Extracted matching substring.

◆ extractAfter()

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

Extracts substrings after specified pattern or position (extractAfter(s, p)).

Parameters

s	Input string array.
p	Position index or pattern.
mr	Memory resource.

Returns: Substring after boundary.

◆ extractBefore()

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

Extracts substrings before specified pattern or position (extractBefore(s, p)).

Parameters

s	Input string array.
p	Position index or pattern.
mr	Memory resource.

Returns: Substring before boundary.

◆ extractBetween()

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

Extracts substrings between specified boundaries (extractBetween(s, start, end)).

Parameters

s	Input string array.
start	1-based start index or start pattern.
end	1-based end index or end pattern.
mr	Memory resource.

Returns: Extracted substring.

◆ formatCyclic()

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

Formats cyclic repetition of format specification across array elements.

Parameters

fmt	Format string.
args	Span of arguments.
argStart	Starting index in args.
mr	Memory resource.

Returns: Formatted string.

◆ formatOnce()

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

Formats single pass of format specification.

Parameters

fmt	Format string.
args	Span of arguments.
argStart	Starting index in args.
literalWhenShort	Format literal string flag when short.

Returns: Formatted string.

◆ hex2dec()

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

Hexadecimal string to decimal (hex2dec(s)).

Parameters

s	Hexadecimal text.
mr	Memory resource.

Returns: Decimal value.

See also: dec2hex

◆ hex2num()

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

Converts 16-character hexadecimal string to IEEE double-precision floating-point number (hex2num(s)).

Parameters

s	Hexadecimal character vector or string array.
mr	Memory resource.

Returns: IEEE 754 double precision floating-point number.

See also: num2hex, hex2dec

◆ insertAfter()

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

Inserts text after specified position or pattern (insertAfter(s, p, newText)).

Parameters

s	Original string.
p	Position index or pattern.
newText	Text to insert.
mr	Memory resource.

Returns: Modified string.

◆ insertBefore()

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

Inserts text before specified position or pattern (insertBefore(s, p, newText)).

Parameters

s	Original string.
p	Position index or pattern.
newText	Text to insert.
mr	Memory resource.

Returns: Modified string.

◆ int2str()

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

Formats integer into character vector (int2str(x)).

Parameters

x	Input integer or numeric value.
mr	Memory resource.

Returns: Character vector representation.

See also: num2str, mat2str

◆ isletter()

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

Tests if characters are letters (isletter(s)).

Parameters

s	Input text.
mr	Memory resource.

Returns: Logical array matching shape of s.

See also: isspace, isstrprop

◆ isspace()

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

Tests if characters are whitespace (isspace(s)).

Parameters

s	Input text.
mr	Memory resource.

Returns: Logical array.

See also: isletter, isstrprop

◆ isspaceFn()

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

Tests if characters are whitespace (internal helper returning Value).

Parameters

s	Input text.
mr	Memory resource.

Returns: Logical array.

◆ isstringscalar()

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

Tests if input is a scalar string (isstringscalar(s)).

Parameters

s	Input value.
mr	Memory resource.

Returns: True if s is a 1x1 string array.

◆ isstrprop() [1/2]

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

Tests if characters have specified string property (isstrprop(s, category)).

Parameters

s	Input text.
category	Property name (e.g. 'alpha', 'digit', 'alphanum', 'punct', 'upper', 'lower').
mr	Memory resource.

Returns: Logical array.

See also: isletter, isspace

◆ isstrprop() [2/2]

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

Tests if characters have specified string property via Value category (isstrprop(s, category)).

Parameters

s	Input text.
category	Property name value.
mr	Memory resource.

Returns: Logical array.

◆ join()

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

Combines elements of string array into single string (join(arr, delim)).

Parameters

arr	Input string array.
delim	Delimiter (default: empty).
mr	Memory resource.

Returns: Joined string scalar.

See also: split, strjoin

◆ lower()

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

Converts string to lowercase (lower(s)).

Parameters

s	Input text.
mr	Memory resource.

Returns: Lowercase text.

See also: upper

◆ mat2str() [1/2]

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

Formats matrix into MATLAB syntax string with precision (mat2str(x, precision)).

Parameters

x	Input matrix.
precision	Number of digits of precision.
mr	Memory resource.

Returns: Formatted character vector.

See also: num2str

◆ mat2str() [2/2]

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

Formats matrix into MATLAB syntax string (mat2str(x)).

Parameters

x	Input matrix.
mr	Memory resource.

Returns: Character vector formatted as MATLAB matrix literal [1, 2; 3, 4].

See also: num2str

◆ matches()

Value nk::builtin::matches	(	const Value &	str,
		const Value &	pat,
		std::pmr::memory_resource *	mr = nullptr )

Tests if strings match pattern (matches(str, pat)).

Parameters

str	Text array.
pat	Pattern string.
mr	Memory resource.

Returns: Logical array.

See also: contains, startsWith, endsWith

◆ newline()

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

Creates newline character string (newline).

Parameters

mr	Memory resource.

Returns: 1 x 1 string scalar containing "\n".

◆ newlineFn()

Value nk::builtin::newlineFn ( std::pmr::memory_resource * mr = nullptr )

Generates newline character as string Value.

Parameters

mr	Memory resource.

Returns: Newline string value.

◆ num2hex()

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

Converts double-precision floating-point number to 16-character hexadecimal string (num2hex(x)).

Parameters

x	Numeric scalar or array.
mr	Memory resource.

Returns: 16-character hexadecimal string representation.

See also: hex2num, dec2hex

◆ num2str() [1/3]

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

Formats numeric array into character vector with format specification (num2str(x, fmt)).

Parameters

x	Input numeric array or scalar.
fmt	C-style printf format string (e.g. "%10.5f").
mr	Memory resource.

Returns: Character vector representation.

See also: int2str, mat2str, str2num

◆ num2str() [2/3]

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

Formats numeric array into character vector with specified precision digits (num2str(x, N)).

Parameters

x	Input numeric array or scalar.
N	Maximum number of significant digits.
mr	Memory resource.

Returns: Character vector representation.

See also: int2str, mat2str, str2num

◆ num2str() [3/3]

Value nk::builtin::num2str	(	const Value &	x,
		std::pmr::memory_resource *	mr = nullptr )

Formats numeric array into character vector (num2str(x)).

Parameters

x	Input numeric array or scalar.
mr	Memory resource for allocations (nullptr for default).

Returns: Character vector representation.

See also: int2str, mat2str, str2num

◆ pad()

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

Pads string to fixed length (pad(s, n, side, padChar)).

Parameters

s	Input string array.
n	Target minimum length.
side	Direction ("left", "right", or "both").
padChar	Character used to pad (default space).
mr	Memory resource.

Returns: Padded string array.

◆ rat()

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

Rational approximation as fraction / continued fraction (rat(x, tol)).

Parameters

x	Input floating-point value.
tol	Error tolerance (default: 0.0 for 1e-6 * norm(x,1)).
mr	Memory resource.

Returns: Cell array {N, D} containing numerator and denominator.

See also: rats

◆ rats()

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

Formats numbers as rational string representations (rats(x, len)).

Parameters

x	Input numeric array.
len	Field length for each rational string (default: 13).
mr	Memory resource.

Returns: Character array of formatted rational strings.

See also: rat

◆ regexp()

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

Regular expression matching (regexp(str, pat)).

Parameters

str	Text to search.
pat	Regular expression pattern.
mr	Memory resource.

Returns: 1-based match start indices or match tokens.

See also: regexpi, regexprep

◆ regexpFind()

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

Regular expression search helper.

Parameters

s	Input text.
pat	Regular expression pattern.
option	Match option string.
ignoreCase	Case-insensitive match flag.
mr	Memory resource.

Returns: Match results Value.

◆ regexpFindOnce()

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

Regular expression search once helper.

Parameters

s	Input text.
pat	Regular expression pattern.
option	Match option string.
ignoreCase	Case-insensitive match flag.
mr	Memory resource.

Returns: First match result Value.

◆ regexpi()

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

Case-insensitive regular expression matching (regexpi(str, pat)).

Parameters

str	Text to search.
pat	Regular expression pattern.
mr	Memory resource.

Returns: Match start indices.

See also: regexp, regexprep

◆ regexprep()

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

Regular expression replacement (regexprep(str, pat, rep, ignoreCase, once)).

Parameters

str	Original text.
pat	Regex pattern.
rep	Replacement string.
ignoreCase	Case-insensitive match flag.
once	Replace first match only flag.
mr	Memory resource.

Returns: Text with matches replaced.

See also: regexp, strrep

◆ regexptranslate() [1/2]

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

Translates wildcard strings to regular expressions (regexptranslate(type, str)).

Parameters

type	Translation type ("wildcard" or "escape").
str	Input string.
mr	Memory resource.

Returns: Regex pattern string.

See also: regexp

◆ regexptranslate() [2/2]

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

Translates wildcard Value to regular expression (regexptranslate(type, str)).

Parameters

type	Translation type ("wildcard" or "escape").
str	Input string value.
mr	Memory resource.

Returns: Regex pattern Value.

◆ replace()

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

Replaces substring pattern with new pattern in string array (replace(s, oldPat, newPat)).

Parameters

s	Input string array.
oldPat	Pattern to replace.
newPat	Replacement text.
mr	Memory resource.

Returns: String array with replacements applied.

◆ replaceBetween()

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

Replaces text between specified start and end boundaries (replaceBetween(s, start, end, newText)).

Parameters

s	Original text.
start	1-based start index or substring pattern.
end	1-based end index or substring pattern.
newText	Replacement text.
mr	Memory resource.

Returns: Text with range replaced.

See also: extractBetween, eraseBetween

◆ reverse()

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

Reverses characters in string (reverse(str)).

Parameters

str	Input string.
mr	Memory resource.

Returns: Reversed string.

◆ split()

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

Splits string array elements by delimiter (split(s, delim)).

Parameters

s	Input string array.
delim	Delimiter pattern.
mr	Memory resource.

Returns: Split string array or cell array.

See also: join, strsplit

◆ splitlines()

Value nk::builtin::splitlines	(	const Value &	s,
		std::pmr::memory_resource *	mr = nullptr )

Splits string into separate lines (splitlines(s)).

Parameters

s	Input string.
mr	Memory resource.

Returns: String array or cell array of individual lines.

See also: strsplit

◆ startsWith()

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

Checks if string starts with pattern (startsWith(str, pat)).

Parameters

str	Text to search.
pat	Prefix pattern.
ignoreCase	Case-insensitive flag.
mr	Memory resource.

Returns: Logical scalar or array.

See also: endsWith, contains

◆ str2double()

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

Converts text to double precision numeric values (str2double(s)).

Parameters

s	Text scalar or string array.
mr	Memory resource.

Returns: Double-precision numeric values (NaN for non-convertible elements).

See also: str2num

◆ str2num()

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

Converts string representation to numeric matrix (str2num(s)).

Parameters

s	Character vector or string.
mr	Memory resource.

Returns: Parsed numeric matrix or empty array on parse failure.

See also: str2double, num2str

◆ strcat()

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

Concatenates strings horizontally (strcat(s1, s2, ...)).

Parameters

args	Span of string arguments.
mr	Memory resource.

Returns: Concatenated string.

See also: strjoin

◆ strcmp()

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

Compares strings for exact equality (case-sensitive) (strcmp(s1, s2)).

Parameters

s1	First string or cell/array.
s2	Second string or cell/array.
mr	Memory resource.

Returns: Logical array or boolean indicating exact elementwise equality.

See also: strcmpi, strncmp, strncmpi

◆ strcmpi()

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

Compares strings for equality ignoring case (strcmpi(s1, s2)).

Parameters

s1	First string.
s2	Second string.
mr	Memory resource.

Returns: Logical result.

See also: strcmp, strncmpi

◆ strfind()

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

Finds occurrences of substring within string (strfind(text, pattern)).

Parameters

text	Input text.
pattern	Substring to find.
mr	Memory resource.

Returns: 1-based start indices of matches.

See also: strrep, contains

◆ string_array()

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

Converts input to string array (string(x)).

Parameters

x	Input value.
mr	Memory resource.

Returns: String array.

See also: char_array, toString

◆ stringsND()

Value nk::builtin::stringsND	(	Span< const size_t >	dims,
		std::pmr::memory_resource *	mr = nullptr )

Constructs an N-dimensional array of empty strings.

Parameters

dims	Dimensions of the target string array.
mr	Memory resource.

Returns: N-D string array initialized to empty strings.

◆ strip() [1/2]

Value nk::builtin::strip	(	const Value &	s,
		const Value &	side,
		const Value &	ch,
		std::pmr::memory_resource *	mr = nullptr )

Strips specified characters from side of string array (strip(s, side, ch)).

Parameters

s	Input string array.
side	Direction ("left", "right", or "both").
ch	Characters to strip.
mr	Memory resource.

Returns: Stripped string array.

◆ strip() [2/2]

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

Strips leading and trailing whitespace from string array (strip(s)).

Parameters

s	Input string array.
mr	Memory resource.

Returns: Stripped string array.

See also: strtrim

◆ strjoin() [1/2]

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

Joins string array with Value delimiter (strjoin(arr, delim)).

Parameters

arr	String array or cell array.
delim	Delimiter Value.
mr	Memory resource.

Returns: Joined character vector.

◆ strjoin() [2/2]

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

Joins string array or cell array of strings with delimiter (strjoin(c, delim)).

Parameters

c	Cell array or string array.
delim	Delimiter string (default: " ").
mr	Memory resource.

Returns: Joined character vector.

See also: strsplit, strcat

◆ strjust()

Value nk::builtin::strjust	(	const Value &	M,
		const std::string &	side = "left",
		std::pmr::memory_resource *	mr = nullptr )

Justifies character matrix (strjust(M, side)).

Parameters

M	Input character matrix.
side	Justification side ("left", "right", "center").
mr	Memory resource.

Returns: Justified character matrix.

◆ strlength()

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

Returns number of characters in each string element (strlength(s)).

Parameters

s	Input string array.
mr	Memory resource.

Returns: Array of element string lengths.

◆ strncmp()

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

Compares first n characters of strings (case-sensitive) (strncmp(s1, s2, n)).

Parameters

s1	First string.
s2	Second string.
n	Number of characters to compare.
mr	Memory resource.

Returns: Logical result.

See also: strcmp, strncmpi

◆ strncmpi()

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

Compares first n characters of strings ignoring case (strncmpi(s1, s2, n)).

Parameters

s1	First string.
s2	Second string.
n	Number of characters to compare.
mr	Memory resource.

Returns: Logical result.

See also: strcmpi, strncmp

◆ strrep()

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

Replaces occurrences of substring within string (strrep(orig, old, new)).

Parameters

orig	Original string.
oldStr	Pattern to replace.
newStr	Replacement string.
mr	Memory resource.

Returns: Modified string.

See also: regexprep, strfind

◆ strsplit() [1/3]

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

Splits string by delimiter string (strsplit(s, delim)).

Parameters

s	Input string.
delim	Delimiter string (default: " ").
mr	Memory resource.

Returns: Cell array of split substrings.

See also: strjoin, splitlines, split

◆ strsplit() [2/3]

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

Splits string by Value delimiter (strsplit(s, delim)).

Parameters

s	Input string.
delim	Delimiter value.
mr	Memory resource.

Returns: Cell array of split substrings.

◆ strsplit() [3/3]

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

Splits string by whitespace (strsplit(s)).

Parameters

s	Input string.
mr	Memory resource.

Returns: Cell array of split substrings.

◆ strtok()

std::pair< Value, Value > nk::builtin::strtok	(	const Value &	str,
		const std::string &	delim = " \t\n\r",
		std::pmr::memory_resource *	mr = nullptr )

Extracts first token from character vector up to delimiter ([token, rem] = strtok(str, delim)).

Parameters

str	Input string.
delim	Delimiter characters (default: " \t\n\r").
mr	Memory resource.

Returns: Pair of {token, remainder} character vectors.

◆ strtrim()

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

Removes leading and trailing whitespace (strtrim(s)).

Parameters

s	Input text.
mr	Memory resource.

Returns: Trimmed text.

See also: deblank, strip

◆ toChar()

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

Alias for char_array conversion (char(x)).

Parameters

x	Input value.
mr	Memory resource.

Returns: Character array.

See also: char_array

◆ toString()

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

Alias for string_array conversion (string(x)).

Parameters

x	Input value.
mr	Memory resource.

Returns: String array.

See also: string_array

◆ upper()

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

Converts string to uppercase (upper(s)).

Parameters

s	Input text.
mr	Memory resource.

Returns: Uppercase text.

See also: lower

◆ validatestring()

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

Validates text against list of valid strings (validatestring(str, validStrings)).

Parameters

str	Query string.
validStrings	Cell or array of valid candidate strings.
mr	Memory resource.

Returns: Unambiguous matched string from validStrings.

Files

Functions

Detailed Description

Function Documentation

◆ append()

◆ base2dec()

◆ bin2dec()

◆ blanks()

◆ char_array()

◆ compose()

◆ contains()

◆ convertCharsToStrings()

◆ convertContainedStringsToChars()

◆ convertStringsToChars()

◆ count()

◆ countFormatSpecs()

◆ deblank()

◆ dec2base()

◆ dec2bin()

◆ dec2hex()

◆ endsWith()

◆ erase()

◆ eraseBetween()

◆ extract()

◆ extractAfter()

◆ extractBefore()

◆ extractBetween()

◆ formatCyclic()

◆ formatOnce()

◆ hex2dec()

◆ hex2num()

◆ insertAfter()

◆ insertBefore()

◆ int2str()

◆ isletter()

◆ isspace()

◆ isspaceFn()

◆ isstringscalar()

◆ isstrprop() [1/2]

◆ isstrprop() [2/2]

◆ join()

◆ lower()

◆ mat2str() [1/2]

◆ mat2str() [2/2]

◆ matches()

◆ newline()

◆ newlineFn()

◆ num2hex()

◆ num2str() [1/3]

◆ num2str() [2/3]

◆ num2str() [3/3]

◆ pad()

◆ rat()

◆ rats()

◆ regexp()

◆ regexpFind()

◆ regexpFindOnce()

◆ regexpi()

◆ regexprep()

◆ regexptranslate() [1/2]

◆ regexptranslate() [2/2]

◆ replace()

◆ replaceBetween()

◆ reverse()

◆ split()

◆ splitlines()

◆ startsWith()

◆ str2double()

◆ str2num()

◆ strcat()

◆ strcmp()

◆ strcmpi()

◆ strfind()

◆ string_array()

◆ stringsND()

◆ strip() [1/2]

◆ strip() [2/2]

◆ strjoin() [1/2]

◆ strjoin() [2/2]

◆ strjust()