• Publicity: Public Only All

ad-functional-procs.tcl

Functional Programming in Tcl? - Absolutely! This library adds the expressive power of functional languages like LISP, Gofer or Haskell to the Tcl language! If you don't know what functional programming is, here's a good place to start:

A general naming convention in this file is: f = a function x = an element xs = a list of elements This library was completely rewritten on July 18, 2000. The design is now much cleaner. Constructed functions are no longer represented by strings, but by real (callable) function objects. The auxiliary functions eval_unary and eval_binary are gone. Special thanks go to Sarah Arnold and Carsten Clasohm for extensive testing of this library and using it in the Sharenet project. Also many thanks to Branimir Dolicki for inventing the lambda function and to Archit Shah for finding a simple way to eliminate its memory leak. This was part of ACS 3. Added to OpenACS by bdolicki on 11 Feb 2004: I just converted proc_doc to ad_proc, added ad_library, fixed an unmatched brace in a doc string and wrapped everything in a namespace.
Location:
packages/acs-tcl/tcl/ad-functional-procs.tcl
Created:
March 29, 2000
Author:
Mark Dettinger <mdettinger@arsdigita.com>
CVS Identification:
$Id: ad-functional-procs.tcl,v 1.12 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

f::abs (public)

 f::abs x
Parameters:
x (required)
Returns:
the absolute value of x

Testcases:
functional_api

f::all (public)

 f::all pred xs

Takes a predicate pred and a list xs and returns 1 if all elements of xs fulfill pred. Examples: f::all f::even_p {2 44 64 80 10} = 1 f::all f::even_p {2 44 65 80 10} = 0

Parameters:
pred (required)
xs (required)
Returns:
boolean

Testcases:
functional_api

f::and (public)

 f::and xs

Reduces a list of boolean values using && Examples: f::and {1 1 0 1} = 0 f::and {1 1 1 1} = 1

Parameters:
xs (required)
Returns:
boolean

Testcases:
functional_api

f::any (public)

 f::any pred xs

Takes a predicate pred and a list xs and returns 1 if there exists an element of xs that fulfills pred. Examples: f::any f::odd_p {2 44 64 80 10} = 0 f::any odd_p {2 44 65 80 10} = 1

Parameters:
pred (required)
xs (required)
Returns:
boolean

Testcases:
functional_api

f::bind (public)

 f::bind f [ args... ]

Binds args to the first k arguments of the n-ary function f and returns the resulting (n-k)-ary function.

Parameters:
f (required)

Testcases:
functional_api

f::bind2nd (public)

 f::bind2nd f arg

Binds arg to the 2nd argument of f.

Parameters:
f (required)
arg (required)

Testcases:
functional_api

f::choose (public)

 f::choose n k

Here's how to compute 'n choose k' like a real nerd.

Parameters:
n (required)
k (required)

Testcases:
No testcase defined.

f::compose (public)

 f::compose f g x

function composition: evaluates f (g x) Example: f::map [f::bind compose sqr [f::bind + 7]] {1 2 3 4 5} = {64 81 100 121 144} Algebraic Property: f::map [f::bind f::compose f g] $xs = f::map f [f::map g $xs]

Parameters:
f (required)
g (required)
x (required)

Testcases:
functional_api

f::cons (public)

 f::cons x xs

Inserts x at the front of the list xs.

Parameters:
x (required)
xs (required)
Returns:
list

Testcases:
functional_api

f::const (public)

 f::const k

Returns a unary function that ignores its argument and constantly returns k. Example: f::map [f::const 7] [list 1 2 3 4 5] = {7 7 7 7 7}

Parameters:
k (required)

Testcases:
functional_api

f::copy (public)

 f::copy n x

Example: f::copy 10 7 = {7 7 7 7 7 7 7 7 7 7}

Parameters:
n (required)
x (required)
Returns:
list of n copies of x

Testcases:
functional_api

f::curry (public)

 f::curry f [ args... ]

Converts a function that takes one tuple as an argument into a function that takes a series of single arguments.

Parameters:
f (required)

Testcases:
functional_api

f::cycle (public)

 f::cycle n xs

Example: f::cycle 4 {1 2 3} = {1 2 3 1 2 3 1 2 3 1 2 3}

Parameters:
n (required)
xs (required)
Returns:
concatenated list of n copies of xs

Testcases:
functional_api

f::drop (public)

 f::drop n xs
Parameters:
n (required)
xs (required)
Returns:
the remaining elements of xs (without the first n)

Testcases:
functional_api

f::drop_while (public)

 f::drop_while p xs
Parameters:
p (required)
xs (required)
Returns:
the remaining portion of the list

Testcases:
functional_api

f::elem_p (public)

 f::elem_p x xs

Checks if x is contained in s.

Parameters:
x (required)
xs (required)
Returns:
boolean

Testcases:
functional_api

f::enum_from_to (public)

 f::enum_from_to lo hi

Generates {lo lo+1 ... hi-1 hi}

Parameters:
lo (required)
hi (required)
Returns:
list

Testcases:
functional_api

f::even_p (public)

 f::even_p n
Parameters:
n (required)
Returns:
1 if n is even and 0 otherwise

Testcases:
functional_api

f::factorial (public)

 f::factorial n

Compute n!

Parameters:
n (required)

Testcases:
functional_api

f::filter (public)

 f::filter pred xs

Examples: f::filter f::even_p {3 1 4 1 5 9 2 6} = {4 2 6} f::filter [f::lambda {x} {expr $x>500}] {317 826 912 318} = {826 912}

Parameters:
pred (required)
xs (required)
Returns:
all elements of the list 'xs' that fulfill the predicate 'pred'.

Testcases:
functional_api

f::flip (public)

 f::flip f a b

Takes a binary function 'f' and two arguments 'a' and 'b' and returns f b a (arguments are flipped). Example: flip lindex 0 {42 37 59 14} = 42

Parameters:
f (required)
a (required)
b (required)

Testcases:
functional_api

f::fold (public)

 f::fold f e xs

Takes a binary function f, a start element e and a list {x1 x2 ...} and returns f (...(f (f (f e x1) x2) x3)...). Examples: f::fold + 0 [list 1 2 3 4] = 10 f::fold * 1 [list 1 2 3 4] = 24

Parameters:
f (required)
e (required)
xs (required)

Testcases:
functional_api

f::fold1 (public)

 f::fold1 f xs

Takes a binary function f and a list {x1 x2 x3 ...} and returns (...(f (f (f x1 x2) x3) x4)...). "fold1" behaves like "fold", but does not take a start element and does not work for empty lists. Examples: f::fold1 min [list 3 1 4 1 5 9 2 6] = 1 f::fold1 max [list 3 1 4 1 5 9 2 6] = 9

Parameters:
f (required)
xs (required)
See Also:
  • fold1

Testcases:
functional_api

f::gcd (public)

 f::gcd x y
Parameters:
x (required)
y (required)
Returns:
the greatest common divisor of x and y

Testcases:
functional_api

f::head (public)

 f::head xs
Parameters:
xs (required)
Returns:
first element of a list

Testcases:
functional_api

f::id (public)

 f::id x

Identity function: just returns its argument. I'm not kidding! An identity function can be useful sometimes, e.g. as a default initializer for optional arguments of functional kind.

Parameters:
x (required)

Testcases:
functional_api

f::init (public)

 f::init xs
Parameters:
xs (required)
Returns:
all elements of a list but the last

Testcases:
functional_api

f::iterate (public)

 f::iterate n f x

Examples: f::iterate 10 [f::lambda {x} {expr $x+1}] 5 = {5 6 7 8 9 10 11 12 13 14} f::iterate 10 [f::lambda {x} {expr $x*2}] 1 = {1 2 4 8 16 32 64 128 256 512} f::iterate 4 f::tail {1 2 3 4 5} = {{1 2 3 4 5} {2 3 4 5} {3 4 5} {4 5}}

Parameters:
n (required)
f (required)
x (required)
Returns:
\{x (f x) (f (f x) (f (f (f x))) ...\}\}.

Testcases:
functional_api

f::lambda (public)

 f::lambda args body

The lambda function - one of the foundations of functional programming - defines an anonymous proc and returns it. This is useful if you quickly need an auxiliary function for a small task. I know, I know - it looks sooo harmless. But it unleashes the real power of Tcl. It defines a proc with name "args.body" (weird, but unique name) that takes "args" as arguments and has the body "body". Then, this proc is returned. Examples: [f::lambda {x} {expr $x*$x}] 5 = 25 f::map [f::lambda {x} {expr $x*$x}] {1 2 3 4 5} = {1 4 9 16 25} f::zip_with [f::lambda {x y} {return "$x and $y"}] {1 2 3} {4 5 6} = "1 and 4" "2 and 5" "3 and 6" Note: Although lambda defines a proc and therefore consumes memory, executing the same lambda expression twice will just re-define this proc. Thus, there is no memory leak, if you have a lambda inside a loop.

Parameters:
args (required)
body (required)
Returns:
a proc name

Testcases:
functional_api

f::last (public)

 f::last xs
Parameters:
xs (required)
Returns:
last element of a list

Testcases:
functional_api

f::lcm (public)

 f::lcm x y
Parameters:
x (required)
y (required)
Returns:
the least common multiple of x and y

Testcases:
functional_api

f::lmax (public)

 f::lmax xs
Parameters:
xs (required)
Returns:
the maximum element of the list xs

Testcases:
functional_api

f::lmin (public)

 f::lmin xs
Parameters:
xs (required)
Returns:
the minimum element of the list xs

Testcases:
functional_api

f::map (public)

 f::map f xs

Takes a function f and a list { x1 x2 x3 ...}, applies the function on each element of the list and returns the result, i.e. { f x1, f x2, f x3, ...}. Examples: (fib = fibonacci function, sqr = square function) Applying a function to each element of a list: f::map fib [list 0 1 2 3 4 5 6 7 8] = {0 1 1 2 3 5 8 13 21} Applying a function to each element of a matrix (a list of lists) can be done with a nested call: f::map [f::lambda {row} {f::map sqr $row}] [list [list 1 2 3] [list 4 5 6]] = {{1 4 9} {16 25 36}}

Parameters:
f (required)
xs (required)

Testcases:
functional_api

f::max (public)

 f::max x y
Parameters:
x (required)
y (required)
Returns:
the maximum of x and y

Testcases:
functional_api

f::min (public)

 f::min x y
Parameters:
x (required)
y (required)
Returns:
the minimum of x and y

Testcases:
functional_api

f::mul (public)

 f::mul n fraction

Multiplies n with a fraction (given as a tuple)

Parameters:
n (required)
fraction (required)

Testcases:
functional_api

f::not_elem_p (public)

 f::not_elem_p x xs

Checks if x is not contained in s.

Parameters:
x (required)
xs (required)
Returns:
boolean

Testcases:
functional_api

f::nub (public)

 f::nub xs

Removes duplicates from xs.

Parameters:
xs (required)

Testcases:
functional_api

f::null_p (public)

 f::null_p xs

Checks if xs is the empty list.

Parameters:
xs (required)
Returns:
boolean

Testcases:
functional_api

f::odd_p (public)

 f::odd_p n
Parameters:
n (required)
Returns:
1 if n is odd and 0 otherwise

Testcases:
functional_api

f::or (public)

 f::or xs

Reduces a list of boolean values using || Example: f::or {1 1 0 1} = 1 f::or {0 0 0 0} = 0

Parameters:
xs (required)
Returns:
boolean

Testcases:
functional_api

f::pascal (public)

 f::pascal size

Prints Pascal's triangle

Parameters:
size (required)

Testcases:
No testcase defined.

f::prime_p (public)

 f::prime_p n

Example: f::filter f::prime_p [f::enum_from_to 1 100] = {2 3 5 7 11 13 17 19 23 29 31 37 41 43 47 53 59 61 67 71 73 79 83 89 97}

Parameters:
n (required)
Returns:
boolean, 1 if n is prime

Testcases:
functional_api

f::product (public)

 f::product xs
Parameters:
xs (required)
Returns:
the product of the elements of the list xs

Testcases:
functional_api

f::products (public)

 f::products xs
Parameters:
xs (required)
Returns:
the list of partial products of the list xs

Testcases:
functional_api

f::qsort (public)

 f::qsort xs [ value ]

Sorts a sequence with the quicksort algorithm. Examples: f::qsort {5 2 9 4} = 2 4 5 9 f::qsort {Oracle ArsDigita SAP Vignette} [lambda {s} {string length $s}] = {SAP Oracle Vignette ArsDigita}

Parameters:
xs (required)
value (optional, defaults to "id")

Testcases:
functional_api

f::reverse (public, deprecated)

 f::reverse xs
Deprecated. Invoking this procedure generates a warning.

Reverses the list xs. Tcl has a built-in support for reversing lists: "lreverse". Use this instead.

Parameters:
xs (required)
See Also:
  • lreverse

Testcases:
No testcase defined.

f::scanl (public)

 f::scanl f e xs

Takes a binary function f, a start element e and a list {x1 x2 ...} and returns {e (f e x1) (f (f e x1) x2) ...}. Example: scanl + 0 [list 1 2 3 4] = {0 1 3 6 10} scanl * 1 [list 1 2 3 4] = {1 1 2 6 24}

Parameters:
f (required)
e (required)
xs (required)

Testcases:
functional_api

f::scanl1 (public)

 f::scanl1 f xs

Takes a binary function f and a list {x1 x2 x3 ...} and returns {x1 (f x1 x2) (f (f x1 x2) x3) ...}. "scanl1" behaves like "scanl", but does not take a start element and does not work for empty lists. Examples: scanl1 min [list 3 1 4 1 5 9 2 6] = {3 1 1 1 1 1 1 1} scanl1 max [list 3 1 4 1 5 9 2 6] = {3 3 4 4 5 9 9 9}

Parameters:
f (required)
xs (required)
See Also:
  • scanl

Testcases:
functional_api

f::span (public)

 f::span p xs

Splits a list using take_while and drop_while. Usage span p xs = (takeWhile p xs, dropWhile p xs)

Parameters:
p (required)
xs (required)

Testcases:
functional_api

f::split_at (public)

 f::split_at n xs

Splits a list using take and drop. Usage: split_at n xs = (take n xs, drop n xs)

Parameters:
n (required)
xs (required)

Testcases:
functional_api

f::sum (public)

 f::sum xs
Parameters:
xs (required)
Returns:
the sum of the elements of the list xs

Testcases:
functional_api

f::sums (public)

 f::sums xs
Parameters:
xs (required)
Returns:
the list of partial sums of the list xs

Testcases:
functional_api

f::tail (public)

 f::tail xs
Parameters:
xs (required)
Returns:
all elements of a list but the first

Testcases:
functional_api

f::take (public)

 f::take n xs
Parameters:
n (required)
xs (required)
Returns:
the first n elements of xs

Testcases:
functional_api

f::take_until (public)

 f::take_until p xs
Parameters:
p (required)
xs (required)
Returns:
the list of elements up to and including the first element of xs which satisfies p

Testcases:
functional_api

f::take_while (public)

 f::take_while p xs
Parameters:
p (required)
xs (required)
Returns:
the longest initial segment of xs whose elements satisfy p

Testcases:
functional_api

f::transpose (public)

 f::transpose lists

Transposes a matrix (a list of lists)

Parameters:
lists (required)

Testcases:
functional_api

f::uncurry (public)

 f::uncurry f tuple

Converts a function that takes a series of single arguments into a function that takes one tuple as an argument. Example: f::min 3 5 = 3 f::min {3 5} = error (because min expects two arguments) f::uncurry min {3 5} = 3

Parameters:
f (required)
tuple (required)

Testcases:
functional_api

f::unzip (public)

 f::unzip xs

Unzip takes a list of tuples {x1 y1} {x2 y2} {x3 y3} ... and returns a tuple of lists {x1 x2 x3 ...} {y1 y2 y3 ...}. It is just a special case of the function "transpose" and is here just for completeness.

Parameters:
xs (required)

Testcases:
functional_api

f::zip (public)

 f::zip [ args... ]

Takes two lists {x1 x2 x3 ...} and {y1 y2 y3 ...} and returns a list of tuples {x1 y1} {x2 y2} {x3 y3} ... Works analogously with 3 or more lists. Example: % set first_names {Nicole Tom} % set last_names {Kidman Cruise} f::zip $first_names $last_names = {{Nicole Kidman} {Tom Cruise}} f::map [f::bind f::flip join _] [f::zip $first_names $last_names] = Nicole_Kidman Tom_Cruise

Testcases:
functional_api

f::zip_with (public)

 f::zip_with f xs ys

Takes two lists {x1 x2 x3 ...} and {y1 y2 y3 ...} and returns the list {(f x1 y1) (f x2 y2) (f x3 y3) ...} Example: % set first_names {Sandra Catherine Nicole} % set last_names {Bullock Zeta-Jones Kidman} f::zip_with [f::lambda {f l} {return "$f $l"}] $first_names $last_names = {{Sandra Bullock} {Catherine Zeta-Jones} {Nicole Kidman}}

Parameters:
f (required)
xs (required)
ys (required)

Testcases:
functional_api
[ show source ]