File: clean-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 (32 lines) | stat: -rw-r--r-- 1,048 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
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => {clean, (clean,RR,Matrix), (clean,RR,MutableMatrix),(clean,RR,Number), (clean,RR,RingElement)},
     Headline => "set to zero elements that are approximately zero",
     Usage => "clean(epsilon,M)\nclean_epsilon M",
     Inputs => {
	  "epsilon" => RR,
	  "M" => Matrix => {"or a ", ofClass RingElement}
	  },
     Outputs => {
	  {ofClass Matrix, ", or ", ofClass RingElement}
	  },
     PARA{"If the input is ", ofClass Matrix, " or ", ofClass RingElement, ", then the result has the same type,
     where each real or complex number coefficient that is less than ", TT "epsilon", " in absolute value
     is replaced with zero."},
     EXAMPLE lines ///
     	  e = 1e-11;
     	  M = random(RR^4,RR^4)
	  M * (M + 1) + 1 - M^2 - M
	  clean_e oo
	  ///,
     "Cleaning a polynomial is a way to get rid of small terms.",
     EXAMPLE lines ///
     	  CC[x];
	  f = product(5,j -> x - exp(2*pi*j*ii/5))
	  clean_e f  
	  ///,
     SeeAlso => {norm, RR, CC, fillMatrix}
     }