File: atan-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 (82 lines) | stat: -rw-r--r-- 2,134 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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
--- status: DRAFT
--- author(s): L. Gold
--- notes:

document { 
     Key => {atan2,(atan2,RR,RR),(atan2, RRi, RRi),
	 (atan2,RR,RRi), (atan2,RRi,RR)
	  },
     Headline => "compute an angle of a certain triangle",
     Usage => "atan2(y,x)\natan2(y,I)\natan2(J,x)\natan2(J,I)",
     Inputs => { "y" => RR, "x" => RR, "J" => RRi, "I" => RRi},
     Outputs => { 
	  RR => { "the angle (in radians) formed with the x-axis by the ray from the origin to the point ", TT "(x,y)" },
      RR => { "an interval containing the angles (in radians) formed with the x-axis by the rays from the origin to the points of ", TT "(I,y),(x,J),(I,J)" }
	  },
     EXAMPLE {
	  "atan2(1,0)",
	  "atan2(0,1)",
	  "atan2(-1,-1)"
	  },
     SeeAlso => { atan }
     }

document { 
     Key => {atan,(atan,RR),(atan,CC),(atan, RRi)},
     Headline => "compute the arctangent of a number",
     Usage => "atan x\natan I",
     Inputs => { "x" => RR, "I" => RRi},
     Outputs => {
	  RR => {"the arctangent (in radians) of ", TT "x"},
      RRi => { "an interval containing the arctangents of the points of ", TT "I" }
	  },
     EXAMPLE {
     	  "atan 1",
	  "abs atan 1 == pi/4"
	  },
     SeeAlso => { atan2 }
     }

document { 
     Key => {acot,(acot,Number)},
     Headline => "compute the inverse cotangent",
     Usage => "acot x",
     Inputs => { "x" => RR },
     Outputs => {
	  RR => {"the arccotangent (in radians) of ", TT "x"} 
	  },
     EXAMPLE {
     	  "acot 2",
	  }
     }

document {
     Key => {atanh, (atanh,Number)},
     Headline => "compute the hyperbolic arctangent of a number",
     Usage => "atanh x",
     Inputs => { "x" => { ofClass Number } },
     Outputs => {
	  Number => { "the hyperbolic arctangent of ", TT "x" }
	  },
     EXAMPLE {
	  "atanh .4",
	  "atanh 4."
	  }
     }

document {
     Key => {acoth, (acoth,Number)},
     Headline => "compute the hyperbolic arctangent of a number",
     Usage => "acoth x",
     Inputs => { "x" => { ofClass Number } },
     Outputs => {
	  Number => { "the hyperbolic arccotangent of ", TT "x" }
	  },
     EXAMPLE {
	  "acoth .4",
	  "acoth 4."
	  }
     }