File: sign-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (29 lines) | stat: -rw-r--r-- 563 bytes parent folder | download | duplicates (2)
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
doc ///
  Key
    sign
    (sign, Number)
    (sign, Constant)
  Headline
    sign (signum) function
  Usage
    sign x
  Inputs
    x:Number
  Outputs
    :{ZZ,CC}
  Description
    Text
      When @VAR "x"@ is real, then this returns 1 if it is positive, -1 if it
      is negative, and 0 if it is zero.
    Example
      sign 5
      sign (-3)
      sign 0
    Text
      If @VAR "x"@ is complex and nonzero, then this returns $x/|x|$.
    Example
      sign(-7*ii)
  SeeAlso
    "GradedLieAlgebras::sign(LieElement)"
    "Permutations::sign(Permutation)"
///