From bb60d4c0a8b29c2dffaa495134c5e4521dbc0976 Mon Sep 17 00:00:00 2001 From: Revar Desmera Date: Tue, 2 May 2023 21:37:03 -0700 Subject: [PATCH] Synopses, etc for fnliterals.scad --- fnliterals.scad | 287 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 199 insertions(+), 88 deletions(-) diff --git a/fnliterals.scad b/fnliterals.scad index f55267f..bd18adc 100644 --- a/fnliterals.scad +++ b/fnliterals.scad @@ -15,7 +15,9 @@ // Function: map() +// Synopsis: Applies a function to each item in a list. // Topics: Function Literals, Looping +// See Also: filter(), reduce(), accumulate(), while(), for_n() // Usage: // lst = map(func, list); // lst = map(function (x) x+1, list); @@ -32,7 +34,6 @@ // Arguments: // func = The function of signature (x) to evaluate for each item in `list`. // list = The input list. -// See Also: filter(), reduce(), accumulate(), while(), for_n() // Example: // func = function(x) x*x; // echo(map(func, [1,2,3,4])); @@ -47,7 +48,9 @@ function map(func, list) = // Function: filter() +// Synopsis: Returns just the list items which the given function returns true for. // Topics: Function Literals, Looping, Filters +// See Also: map(), reduce(), accumulate(), while(), for_n(), find_all() // Usage: // lst = filter(func, list); // lst = filter(function (x) x>1, list); @@ -65,7 +68,6 @@ function map(func, list) = // Arguments: // func = The function of signature `function (x)` to evaluate for each item in `list`. // list = The input list. -// See Also: map(), reduce(), accumulate(), while(), for_n() // Example: // func = function(x) x>5; // echo(filter(func, [3,4,5,6,7])); @@ -77,7 +79,9 @@ function filter(func, list) = // Function: reduce() +// Synopsis: Applies a 2-arg function cumulatively to the items of a list, returning the final result. // Topics: Function Literals, Looping +// See Also: map(), filter(), accumulate(), while(), for_n() // Usage: // res = reduce(func, list, [init]); // res = reduce(function (a,b) a+b, list, 1, list); @@ -256,7 +264,6 @@ function for_n(n,init,func) = // Arguments: // func = The function of signature `function (x)` to evaluate for each item in `list`. // list = The input list. -// See Also: find_all(), map(), reduce(), accumulate(), while(), for_n() // Example: // func = function(x) x>5; // echo(find_all(func, [3,4,5,6,7])); @@ -268,15 +275,16 @@ function find_all(func, list) = // Function: find_first() +// Synopsis: Returns the index of the first item in a list, after `start`, that a given function returns true for. // Topics: Function Literals, Searching +// See Also: find_all(), filter(), binsearch(), find_all() // Usage: // idx = find_first(func, list, [start=]); // Description: -// Finds the first item in `list`, after index `start`, which the function literal in `func` will return true for. +// Finds the index of the first item in `list`, after index `start`, which the function literal in `func` will return true for. // The signature of the function literal in `func` is `function (x)`, and it is expected to return true when the // value compares as matching. It should return false otherwise. If you need to find *all* matching items in the // list, you should use {{find_all()}} instead. -// See Also: find_all(), map(), filter(), reduce(), accumulate(), while(), for_n(), binsearch() // Arguments: // func = The function literal to use to check each item in `list`. Expects the signature `function (x)`, and a boolean return value. // list = The list to search. @@ -306,7 +314,9 @@ function find_first(func, list, start=0) = // Function: binsearch() +// Synopsis: Does a binary search of a sorted list to find the index of a given value. // Topics: Function Literals, Data Structures, Searching +// See Also: map(), filter(), reduce(), accumulate(), hashmap(), find_all(), find_first() // Usage: // idx = binsearch(key,list, [cmp]); // Description: @@ -317,7 +327,6 @@ function find_first(func, list, start=0) = // list = The list of items to search through. // idx = If given, the index of the item sublists to use as the item key. // cmp = The comparator function literal to use. Default: `f_cmp()` -// See Also: map(), filter(), reduce(), accumulate(), hashmap() // Example: // items = unique(rands(0,100,10000)); // idx = binsearch(44, items); @@ -342,14 +351,15 @@ function binsearch(key, list, idx, cmp=f_cmp()) = // Function: simple_hash() +// Synopsis: Returns an integer hash of a given value. // Topics: Function Literals, Hashing, Data Structures +// See Also: hashmap() // Usage: // hx = simple_hash(x); // Description: // Given an arbitrary value, returns the integer hash value for it. // Arguments: // x = The value to get the simple hash value of. -// See Also: hashmap() // Example: // x = simple_hash("Foobar"); // x = simple_hash([[10,20],[-5,3]]); @@ -367,7 +377,9 @@ function simple_hash(x) = // Function: hashmap() +// Synopsis: Creates a hashmap manipulation function. // Topics: Function Literals, Data Structures, Hashing +// See Also: simple_hash() // Usage: Creating an Empty HashMap. // hm = hashmap([hashsize=]); // Usage: Creating a Populated HashMap. @@ -445,7 +457,8 @@ function hashmap(hashsize=127,items,table) = // Function: f_1arg() -// Topics: Function Literals, Function Literal Factories +// Synopsis: Creates a factory for a 2-arg function literal, where you can optionally pre-fill the arg. +// Topics: Function Literals // See Also: f_2arg(), f_3arg() // Usage: // fn = f_1arg(func); @@ -463,7 +476,8 @@ function f_1arg(target_func) = // Function: f_2arg() -// Topics: Function Literals, Function Literal Factories +// Synopsis: Creates a factory for a 2-arg function literal, where you can optionally pre-fill the args. +// Topics: Function Literals // See Also: f_1arg(), f_3arg() // Usage: // fn = f_2arg(target_func); @@ -487,7 +501,8 @@ function f_2arg(target_func) = // Function: f_2arg_simple() -// Topics: Function Literals, Function Literal Factories +// Synopsis: Creates a factory for a 2-arg function literal, where you can optionally pre-fill the args. +// Topics: Function Literals // See Also: f_1arg(), f_3arg() // Usage: // fn = f_2arg_simple(target_func); @@ -509,7 +524,8 @@ function f_2arg_simple(target_func) = // Function: f_3arg() -// Topics: Function Literals, Function Literal Factories +// Synopsis: Creates a factory for a 3-arg function literal, where you can optionally pre-fill the args. +// Topics: Function Literals // See Also: f_1arg(), f_2arg() // Usage: // fn = f_3arg(target_func); @@ -537,6 +553,9 @@ function f_3arg(target_func) = // Function: ival() +// Synopsis: Generates a function with signature `(i,x)` that calls `func(i)` +// Topics: Function Literals +// See Also: f_1arg(), f_2arg(), f_3arg(), ival(), xval() // Usage: // newfunc = ival(func); // Description: @@ -553,6 +572,9 @@ function ival(target_func) = function(a,b) target_func(a); // Function: xval() +// Synopsis: Generates a function with signature `(i,x)` that calls `func(x)` +// Topics: Function Literals +// See Also: f_1arg(), f_2arg(), f_3arg(), ival(), xval() // Usage: // newfunc = xval(func); // Description: @@ -574,6 +596,9 @@ function xval(target_func) = function(a,b) target_func(b); // Function: f_cmp() +// Synopsis: Returns a function to compare values. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_cmp(); // fn = f_cmp(b); @@ -590,6 +615,9 @@ function f_cmp(a,b) = f_2arg_simple(function (a,b) a==b?0: a>b?1: -1)(a,b); // Function: f_gt() +// Synopsis: Returns a function to compare if `a` is greater than `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_gt(); // fn = f_gt(b); @@ -605,6 +633,9 @@ function f_gt(a,b) = f_2arg_simple(function (a,b) a>b)(a,b); // Function: f_lt() +// Synopsis: Returns a function to compare if `a` is less than `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_lt(); // fn = f_lt(b); @@ -620,6 +651,9 @@ function f_lt(a,b) = f_2arg_simple(function (a,b) a=b)(a,b); // Function: f_lte() +// Synopsis: Returns a function to compare if `a` is less than or equal to `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_lte(); // fn = f_lte(b); @@ -650,6 +687,9 @@ function f_lte(a,b) = f_2arg_simple(function (a,b) a<=b)(a,b); // Function: f_eq() +// Synopsis: Returns a function to compare if `a` is exactly equal to `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_eq(); // fn = f_eq(b); @@ -665,6 +705,9 @@ function f_eq(a,b) = f_2arg_simple(function (a,b) a==b)(a,b); // Function: f_neq() +// Synopsis: Returns a function to compare if `a` is not exactly equal to `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_neq(); // fn = f_neq(b); @@ -680,6 +723,9 @@ function f_neq(a,b) = f_2arg_simple(function (a,b) a!=b)(a,b); // Function: f_approx() +// Synopsis: Returns a function to compare if `a` is approximately equal to `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_approx(); // fn = f_approx(b); @@ -695,6 +741,9 @@ function f_approx(a,b) = f_2arg_simple(function (a,b) approx(a,b))(a,b); // Function: f_napprox() +// Synopsis: Returns a function to compare if `a` is not approximately equal to `b`. +// Topics: Function Literals, Comparators +// See Also: f_cmp(), f_gt(), f_lt(), f_gte(), f_lte(), f_eq(), f_neq(), f_approx(), f_napprox() // Usage: // fn = f_napprox(); // fn = f_napprox(b); @@ -715,7 +764,9 @@ function f_napprox(a,b) = f_2arg_simple(function (a,b) !approx(a,b))(a,b); // Function: f_or() +// Synopsis: Returns a function to check if either `a` or `b` is true. // Topics: Function Literals, Logic, Boolean Operations +// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() // Usage: // fn = f_or(); // fn = f_or(a=); @@ -727,12 +778,13 @@ function f_napprox(a,b) = f_2arg_simple(function (a,b) !approx(a,b))(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() function f_or(a,b) = f_2arg(function(a,b) (a || b))(a,b); // Function: f_and() +// Synopsis: Returns a function to check if both `a` and `b` are true. // Topics: Function Literals, Logic, Boolean Operations +// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() // Usage: // fn = f_and(); // fn = f_and(a=); @@ -744,12 +796,13 @@ function f_or(a,b) = f_2arg(function(a,b) (a || b))(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() function f_and(a,b) = f_2arg(function(a,b) (a && b))(a,b); // Function: f_nor() +// Synopsis: Returns a function to check if neither `a` nor `b` are true. // Topics: Function Literals, Logic, Boolean Operations +// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() // Usage: // fn = f_nor(); // fn = f_nor(a=); @@ -761,12 +814,13 @@ function f_and(a,b) = f_2arg(function(a,b) (a && b))(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() function f_nor(a,b) = f_2arg(function(a,b) !(a || b))(a,b); // Function: f_nand() +// Synopsis: Returns a function to check if `a` and `b` are not both true. // Topics: Function Literals, Logic, Boolean Operations +// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() // Usage: // fn = f_nand(); // fn = f_nand(a=); @@ -778,12 +832,13 @@ function f_nor(a,b) = f_2arg(function(a,b) !(a || b))(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() function f_nand(a,b) = f_2arg(function(a,b) !(a && b))(a,b); // Function: f_xor() +// Synopsis: Returns a function to check if either `a` or `b`, but not both, are true. // Topics: Function Literals, Logic, Boolean Operations +// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() // Usage: // fn = f_xor(); // fn = f_xor(a=); @@ -795,12 +850,13 @@ function f_nand(a,b) = f_2arg(function(a,b) !(a && b))(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() function f_xor(a,b) = f_2arg(function(a,b) (!a && b) || (a && !b))(a,b); // Function: f_not() +// Synopsis: Returns a function to check if `a` is not true. // Topics: Function Literals, Logic, Boolean Operations +// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() // Usage: // fn = f_not(); // fn = f_not(a); @@ -809,12 +865,13 @@ function f_xor(a,b) = f_2arg(function(a,b) (!a && b) || (a && !b))(a,b); // argument can be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not() function f_not(a) = f_1arg(function(a) !a)(a); // Function: f_even() +// Synopsis: Returns a function to check if `a` is an even number. // Topics: Function Literals, Math Operators +// See Also: f_even(), f_odd() // Usage: // fn = f_even(); // fn = f_even(a); @@ -823,14 +880,15 @@ function f_not(a) = f_1arg(function(a) !a)(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not(), f_even(), f_odd() // Example: // l2 = filter(f_even(), [3,4,5,6,7,8]); // Returns: [4,6,8] function f_even(a) = f_1arg(function(a) a % 2 == 0)(a); // Function: f_odd() +// Synopsis: Returns a function to check if `a` is an odd number. // Topics: Function Literals, Math Operators +// See Also: f_even(), f_odd() // Usage: // fn = f_odd(); // fn = f_odd(a); @@ -839,7 +897,6 @@ function f_even(a) = f_1arg(function(a) a % 2 == 0)(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_or(), f_and(), f_nor(), f_nand(), f_xor(), f_not(), f_even(), f_odd() // Example: // l2 = filter(f_odd(), [3,4,5,6,7,8]); // Returns: [3,5,7] function f_odd(a) = f_1arg(function(a) a % 2 != 0)(a); @@ -851,7 +908,9 @@ function f_odd(a) = f_1arg(function(a) a % 2 != 0)(a); // Function: f_add() +// Synopsis: Returns a function to add `a` and `b`. // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_add(); // fn = f_add(a=); @@ -863,12 +922,13 @@ function f_odd(a) = f_1arg(function(a) a % 2 != 0)(a); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_add(a,b) = f_2arg(function(a,b) a + b)(a,b); // Function: f_sub() +// Synopsis: Returns a function to subtract `a` from `b`. // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_sub(); // fn = f_sub(a=); @@ -880,12 +940,13 @@ function f_add(a,b) = f_2arg(function(a,b) a + b)(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_sub(a,b) = f_2arg(function(a,b) a - b)(a,b); // Function: f_mul() +// Synopsis: Returns a function to multiply `a` by `b`. // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_mul(); // fn = f_mul(a=); @@ -897,12 +958,13 @@ function f_sub(a,b) = f_2arg(function(a,b) a - b)(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_mul(a,b) = f_2arg(function(a,b) a * b)(a,b); // Function: f_div() +// Synopsis: Returns a function to divide `a` by `b`. // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_div(); // fn = f_div(a=); @@ -914,12 +976,13 @@ function f_mul(a,b) = f_2arg(function(a,b) a * b)(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_div(a,b) = f_2arg(function(a,b) a / b)(a,b); // Function: f_mod() +// Synopsis: Returns a function to calculate the modulo of `a` divided by `b`. // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_mod(); // fn = f_mod(a=); @@ -931,12 +994,13 @@ function f_div(a,b) = f_2arg(function(a,b) a / b)(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_mod(a,b) = f_2arg(function(a,b) a % b)(a,b); // Function: f_pow() +// Synopsis: Returns a function to calculate `a` to the power of `b`. // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_pow(); // fn = f_pow(a=); @@ -948,12 +1012,13 @@ function f_mod(a,b) = f_2arg(function(a,b) a % b)(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_pow(a,b) = f_2arg(function(a,b) pow(a,b))(a,b); // Function: f_neg() +// Synopsis: Returns a function to calculate `-a` // Topics: Function Literals, Math Operators +// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() // Usage: // fn = f_neg(); // fn = f_neg(a); @@ -962,7 +1027,6 @@ function f_pow(a,b) = f_2arg(function(a,b) pow(a,b))(a,b); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_add(), f_sub(), f_mul(), f_div(), f_mod(), f_pow(), f_neg() function f_neg(a) = f_1arg(function(a) -a)(a); @@ -972,7 +1036,9 @@ function f_neg(a) = f_1arg(function(a) -a)(a); // Function: f_min() +// Synopsis: Returns a function to calculate the minimum value of a list. // Topics: Function Literals, Math Operators +// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() // Usage: // fn = f_min(); // fn = f_min(a); @@ -981,12 +1047,13 @@ function f_neg(a) = f_1arg(function(a) -a)(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() function f_min(a) = f_1arg(function(a) min(a))(a); // Function: f_max() +// Synopsis: Returns a function to calculate the maximum value of a list. // Topics: Function Literals, Math Operators +// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() // Usage: // fn = f_max(); // fn = f_max(a); @@ -995,12 +1062,13 @@ function f_min(a) = f_1arg(function(a) min(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() function f_max(a) = f_1arg(function(a) max(a))(a); // Function: f_min2() +// Synopsis: Returns a function to calculate the minimum of two values. // Topics: Function Literals, Math Operators +// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() // Usage: // fn = f_min2(); // fn = f_min2(a=); @@ -1012,12 +1080,13 @@ function f_max(a) = f_1arg(function(a) max(a))(a); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() function f_min2(a,b) = f_2arg(function(a,b) min(a,b))(a,b); // Function: f_max2() +// Synopsis: Returns a function to calculate the maximum of two values. // Topics: Function Literals, Math Operators +// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() // Usage: // fn = f_max2(); // fn = f_max2(a=); @@ -1029,12 +1098,13 @@ function f_min2(a,b) = f_2arg(function(a,b) min(a,b))(a,b); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() function f_max2(a,b) = f_2arg(function(a,b) max(a,b))(a,b); // Function: f_min3() +// Synopsis: Returns a function to calculate the minimum of three values. // Topics: Function Literals, Math Operators +// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() // Usage: // fn = f_min3(); // fn = f_min3(a=); @@ -1051,12 +1121,13 @@ function f_max2(a,b) = f_2arg(function(a,b) max(a,b))(a,b); // a = If given, replaces the first argument. // b = If given, replaces the second argument. // c = If given, replaces the third argument. -// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() function f_min3(a,b,c) = f_3arg(function(a,b,c) min(a,b,c))(a,b,c); // Function: f_max3() +// Synopsis: Returns a function to calculate the maximum of three values. // Topics: Function Literals, Math Operators +// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() // Usage: // fn = f_max3(); // fn = f_max3(a=); @@ -1073,7 +1144,6 @@ function f_min3(a,b,c) = f_3arg(function(a,b,c) min(a,b,c))(a,b,c); // a = If given, replaces the first argument. // b = If given, replaces the second argument. // c = If given, replaces the third argument. -// See Also: f_min(), f_max(), f_min2(), f_max2(), f_min3(), f_max3() function f_max3(a,b,c) = f_3arg(function(a,b,c) max(a,b,c))(a,b,c); @@ -1083,7 +1153,9 @@ function f_max3(a,b,c) = f_3arg(function(a,b,c) max(a,b,c))(a,b,c); // Function: f_sin() +// Synopsis: Returns a function to calculate the sine of a value. // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_sin(); // fn = f_sin(a); @@ -1092,12 +1164,13 @@ function f_max3(a,b,c) = f_3arg(function(a,b,c) max(a,b,c))(a,b,c); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_sin(a) = f_1arg(function(a) sin(a))(a); // Function: f_cos() +// Synopsis: Returns a function to calculate the cosine of a value. // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_cos(); // fn = f_cos(a); @@ -1106,12 +1179,13 @@ function f_sin(a) = f_1arg(function(a) sin(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_cos(a) = f_1arg(function(a) cos(a))(a); // Function: f_tan() +// Synopsis: Returns a function to calculate the tangent of a value. // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_tan(); // fn = f_tan(a); @@ -1120,12 +1194,13 @@ function f_cos(a) = f_1arg(function(a) cos(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_tan(a) = f_1arg(function(a) tan(a))(a); // Function: f_asin() +// Synopsis: Returns a function to calculate the arcsine of a value. // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_asin(); // fn = f_asin(a); @@ -1134,12 +1209,13 @@ function f_tan(a) = f_1arg(function(a) tan(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_asin(a) = f_1arg(function(a) asin(a))(a); // Function: f_acos() +// Synopsis: Returns a function to calculate the arccosine of a value. // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_acos(); // fn = f_acos(a); @@ -1148,12 +1224,13 @@ function f_asin(a) = f_1arg(function(a) asin(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_acos(a) = f_1arg(function(a) acos(a))(a); // Function: f_atan() +// Synopsis: Returns a function to calculate the arctangent of a value. // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_atan(); // fn = f_atan(a); @@ -1162,12 +1239,13 @@ function f_acos(a) = f_1arg(function(a) acos(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_atan(a) = f_1arg(function(a) atan(a))(a); // Function: f_atan2() +// Synopsis: Returns a function to calculate the arctangent of `y` and `x` // Topics: Function Literals, Math Operators +// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() // Usage: // fn = f_atan2(); // fn = f_atan2(a=); @@ -1179,7 +1257,6 @@ function f_atan(a) = f_1arg(function(a) atan(a))(a); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_sin(), f_cos(), f_tan(), f_asin(), f_acos(), f_atan(), f_atan2() function f_atan2(a,b) = f_2arg(function(a,b) atan2(a,b))(a,b); @@ -1189,7 +1266,9 @@ function f_atan2(a,b) = f_2arg(function(a,b) atan2(a,b))(a,b); // Function: f_len() +// Synopsis: Returns a function to calculate the length of a string or list. // Topics: Function Literals, String Operators +// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() // Usage: // fn = f_len(); // fn = f_len(a); @@ -1198,12 +1277,13 @@ function f_atan2(a,b) = f_2arg(function(a,b) atan2(a,b))(a,b); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() function f_len(a) = f_1arg(function(a) len(a))(a); // Function: f_chr() +// Synopsis: Returns a function to get a string character from its ordinal number. // Topics: Function Literals, String Operators +// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() // Usage: // fn = f_chr(); // fn = f_chr(a); @@ -1212,12 +1292,13 @@ function f_len(a) = f_1arg(function(a) len(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() function f_chr(a) = f_1arg(function(a) chr(a))(a); // Function: f_ord() +// Synopsis: Returns a function to get the ordinal number of a string character. // Topics: Function Literals, String Operators +// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() // Usage: // fn = f_ord(); // fn = f_ord(a); @@ -1226,12 +1307,13 @@ function f_chr(a) = f_1arg(function(a) chr(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() function f_ord(a) = f_1arg(function(a) ord(a))(a); // Function: f_str() +// Synopsis: Returns a function to get the string representation of an arbitrary value. // Topics: Function Literals, String Operators +// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() // Usage: // fn = f_str(); // fn = f_str(a); @@ -1240,12 +1322,13 @@ function f_ord(a) = f_1arg(function(a) ord(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() function f_str(a) = f_1arg(function(a) str(a))(a); // Function: f_str2() +// Synopsis: Returns a function to concatenate the string representations of two arbitrary values. // Topics: Function Literals, String Operators +// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() // Usage: // fn = f_str2(); // fn = f_str2(a=); @@ -1257,12 +1340,13 @@ function f_str(a) = f_1arg(function(a) str(a))(a); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() function f_str2(a,b) = f_2arg(function(a,b) str(a,b))(a,b); // Function: f_str3() +// Synopsis: Returns a function to concatenate the string representations of three arbitrary values. // Topics: Function Literals, Math Operators +// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() // Usage: // fn = f_str3(); // fn = f_str3(a=); @@ -1279,7 +1363,6 @@ function f_str2(a,b) = f_2arg(function(a,b) str(a,b))(a,b); // a = If given, replaces the first argument. // b = If given, replaces the second argument. // c = If given, replaces the third argument. -// See Also: f_len(), f_chr(), f_ord(), f_str(), f_str2(), f_str3() function f_str3(a,b,c) = f_3arg(function(a,b,c) str(a,b,c))(a,b,c); @@ -1289,7 +1372,9 @@ function f_str3(a,b,c) = f_3arg(function(a,b,c) str(a,b,c))(a,b,c); // Function: f_floor() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the integer floor of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_floor(), f_ceil(), f_round() // Usage: // fn = f_floor(); // fn = f_floor(a); @@ -1298,12 +1383,13 @@ function f_str3(a,b,c) = f_3arg(function(a,b,c) str(a,b,c))(a,b,c); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_floor(), f_ceil(), f_round() function f_floor(a) = f_1arg(function(a) floor(a))(a); // Function: f_round() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the integer rounding of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_floor(), f_ceil(), f_round() // Usage: // fn = f_round(); // fn = f_round(a); @@ -1312,12 +1398,13 @@ function f_floor(a) = f_1arg(function(a) floor(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_floor(), f_ceil(), f_round() function f_round(a) = f_1arg(function(a) round(a))(a); // Function: f_ceil() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the integer ceiling of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_floor(), f_ceil(), f_round() // Usage: // fn = f_ceil(); // fn = f_ceil(a); @@ -1326,12 +1413,13 @@ function f_round(a) = f_1arg(function(a) round(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_floor(), f_ceil(), f_round() function f_ceil(a) = f_1arg(function(a) ceil(a))(a); // Function: f_abs() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the absolute value of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_abs(); // fn = f_abs(a); @@ -1340,12 +1428,13 @@ function f_ceil(a) = f_1arg(function(a) ceil(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_abs(a) = f_1arg(function(a) abs(a))(a); // Function: f_sign() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the sign of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_sign(); // fn = f_sign(a); @@ -1354,12 +1443,13 @@ function f_abs(a) = f_1arg(function(a) abs(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_sign(a) = f_1arg(function(a) sign(a))(a); // Function: f_ln() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the natural logarithm of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_ln(); // fn = f_ln(a); @@ -1368,12 +1458,13 @@ function f_sign(a) = f_1arg(function(a) sign(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_ln(a) = f_1arg(function(a) ln(a))(a); // Function: f_log() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the base 10 logarithm of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_log(); // fn = f_log(a); @@ -1382,12 +1473,13 @@ function f_ln(a) = f_1arg(function(a) ln(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_log(a) = f_1arg(function(a) log(a))(a); // Function: f_exp() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the natural exponent of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_exp(); // fn = f_exp(a); @@ -1396,12 +1488,13 @@ function f_log(a) = f_1arg(function(a) log(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_exp(a) = f_1arg(function(a) exp(a))(a); // Function: f_sqr() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the square of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_sqr(); // fn = f_sqr(a); @@ -1410,12 +1503,13 @@ function f_exp(a) = f_1arg(function(a) exp(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_sqr(a) = f_1arg(function(a) a*a)(a); // Function: f_sqrt() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the square root of a given number. +// Topics: Function Literals, Math Operators +// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() // Usage: // fn = f_sqrt(); // fn = f_sqrt(a); @@ -1424,12 +1518,13 @@ function f_sqr(a) = f_1arg(function(a) a*a)(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_sqrt(a) = f_1arg(function(a) sqrt(a))(a); // Function: f_norm() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the norm of a given vector. +// Topics: Function Literals, Vectors +// See Also: f_norm(), f_abs(), f_sign(), f_cross() // Usage: // fn = f_norm(); // fn = f_norm(a); @@ -1438,12 +1533,13 @@ function f_sqrt(a) = f_1arg(function(a) sqrt(a))(a); // argument can optionally be replaced with a constant. // Arguments: // a = If given, replaces the argument. -// See Also: f_abs(), f_sign(), f_ln(), f_log(), f_exp(), f_sqr(), f_sqrt() function f_norm(a) = f_1arg(function(a) norm(a))(a); // Function: f_cross() -// Topics: Function Literals, String Operators +// Synopsis: Returns a function to calculate the norm of a given vector. +// Topics: Function Literals, Vectors +// See Also: f_norm(), f_abs(), f_sign(), f_cross() // Usage: // fn = f_cross(); // fn = f_cross(a=); @@ -1455,201 +1551,216 @@ function f_norm(a) = f_1arg(function(a) norm(a))(a); // Arguments: // a = If given, replaces the first argument. // b = If given, replaces the second argument. -// See Also: f_norm(), f_abs(), f_sign(), f_cross() function f_cross(a,b) = f_2arg(function(a,b) cross(a,b))(a,b); // Section: Type Queries // Function: f_is_def() +// Synopsis: Returns a function to determine if a value is not `undef`. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_string(), f_is_list() // Usage: // fn = f_is_def(); // Description: // A factory that returns function literals equivalent to `is_def(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_string(), f_is_list() function f_is_def(x) = f_1arg(function (x) is_def(x)); // Function: f_is_undef() +// Synopsis: Returns a function to determine if a value is `undef`. // Topics: Function Literals, Type Queries +// See Also: f_is_bool(), f_is_num(), f_is_string(), f_is_list() // Usage: // fn = f_is_undef(); // Description: // A factory that returns function literals equivalent to `is_undef(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_bool(), f_is_num(), f_is_string(), f_is_list() function f_is_undef(x) = f_1arg(function (x) is_undef(x)); // Function: f_is_bool() +// Synopsis: Returns a function to determine if a value is a boolean. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_num(), f_is_string(), f_is_list() // Usage: // fn = f_is_bool(); // Description: // A factory that returns function literals equivalent to `is_bool(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_num(), f_is_string(), f_is_list() function f_is_bool(x) = f_1arg(function (x) is_bool(x)); // Function: f_is_num() +// Synopsis: Returns a function to determine if a value is a number. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_string(), f_is_list() // Usage: // fn = f_is_num(); // Description: // A factory that returns function literals equivalent to `is_num(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_string(), f_is_list() function f_is_num(x) = f_1arg(function (x) is_num(x)); // Function: f_is_int() +// Synopsis: Returns a function to determine if a value is an integer number. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_string(), f_is_list() // Usage: // fn = f_is_int(); // Description: // A factory that returns function literals equivalent to `is_int(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_string(), f_is_list() function f_is_int(x) = f_1arg(function (x) is_int(x)); // Function: f_is_nan() +// Synopsis: Returns a function to determine if a value is a number type that is Not a Number (NaN). // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_nan(); // Description: // A factory that returns function literals equivalent to `is_nan(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_nan(x) = f_1arg(function (x) is_nan(x)); // Function: f_is_finite() +// Synopsis: Returns a function to determine if a value is a number type that is finite. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_finite(); // Description: // A factory that returns function literals equivalent to `is_finite(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_finite(x) = f_1arg(function (x) is_finite(x)); // Function: f_is_string() +// Synopsis: Returns a function to determine if a value is a string. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_list() // Usage: // fn = f_is_string(); // Description: // A factory that returns function literals equivalent to `is_string(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_list() function f_is_string(x) = f_1arg(function (x) is_string(x)); // Function: f_is_list() +// Synopsis: Returns a function to determine if a value is a list. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_list(); // Description: // A factory that returns function literals equivalent to `is_list(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_list(x) = f_1arg(function (x) is_list(x)); // Function: f_is_range() +// Synopsis: Returns a function to determine if a value is a range. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_range(); // Description: // A factory that returns function literals equivalent to `is_range(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_range(x) = f_1arg(function (x) is_range(x)); // Function: f_is_function() +// Synopsis: Returns a function to determine if a value is a function literal. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_function(); // Description: // A factory that returns function literals equivalent to `is_function(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_function(x) = f_1arg(function (x) is_function(x)); // Function: f_is_vector() +// Synopsis: Returns a function to determine if a value is a list of numbers. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_vector(); // Description: // A factory that returns function literals equivalent to `is_vector(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_vector(a,b) = f_2arg(function (a,b) is_vector(a,b)); // Function: f_is_path() +// Synopsis: Returns a function to determine if a value is a Path (a list of points). // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_path(); // Description: // A factory that returns function literals equivalent to `is_path(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_path(a,b) = f_2arg(function (a,b) is_path(a,b)); // Function: f_is_region() +// Synopsis: Returns a function to determine if a value is a Region (a list of Paths). // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_region(); // Description: // A factory that returns function literals equivalent to `is_region(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_region(a) = f_1arg(function (a) is_region(a)); // Function: f_is_vnf() +// Synopsis: Returns a function to determine if a value is a VNF structure. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_vnf(); // Description: // A factory that returns function literals equivalent to `is_vnf(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_vnf(a) = f_1arg(function (a) is_vnf(a)); // Function: f_is_patch() +// Synopsis: Returns a function to determine if a value is a Bezier Patch structure. // Topics: Function Literals, Type Queries +// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() // Usage: // fn = f_is_patch(); // Description: // A factory that returns function literals equivalent to `is_patch(a)`. // Arguments: // a = If given, replaces the argument. -// See Also: f_is_undef(), f_is_bool(), f_is_num(), f_is_int(), f_is_string(), f_is_list() function f_is_patch(a) = f_1arg(function (a) is_patch(a));