git @ Cat's Eye Technologies Robin / master stdlib / sign.robin
master

Tree @master (Download .tar.gz)

sign.robin @master — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
;'<<SPEC'

<!--
Copyright (c) 2012-2024, Chris Pressey, Cat's Eye Technologies.
This file is distributed under a 2-clause BSD license.  See LICENSES/ dir.
SPDX-License-Identifier: LicenseRef-BSD-2-Clause-X-Robin
-->

### `sign` ###

    -> Tests for functionality "Evaluate Robin Expression (with literal)"

`sign` evaluates its sole argument to a number, then
evaluates to 0 if that number is 0, 1 if that number is positive, or
-1 if that number is negative.

    | (sign 26)
    = 1

    | (sign 0)
    = 0

    | (sign (subtract 0 200))
    = -1

`sign` expects a number.

    | (sign #f)
    ? abort (expected-number #f)

    | (sign (literal k))
    ? abort (expected-number k)

`sign` expects exactly one argument.

    | (sign 100 200 300)
    ? abort (illegal-arguments (100 200 300))

    | (sign)
    ? abort (illegal-arguments ())

'<<SPEC'

(require sign)