docs.json

{"reExports":[],"name":"Math","comments":"Wraps the math functions and constants from Javascript's built-in `Math` object.\nSee [Math Reference at MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math).\n","declarations":[{"children":[],"comments":"An alias to make types in this module more explicit.\n","title":"Radians","info":{"arguments":[],"declType":"typeSynonym","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[6,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[6,22]}},{"children":[],"comments":"Returns the absolute value of the argument.\n","title":"abs","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[9,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[9,39]}},{"children":[],"comments":"Returns the inverse cosine of the argument.\n","title":"acos","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]}},"sourceSpan":{"start":[12,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[12,41]}},{"children":[],"comments":"Returns the inverse sine of the argument.\n","title":"asin","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]}},"sourceSpan":{"start":[15,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[15,41]}},{"children":[],"comments":"Returns the inverse tangent of the argument.\n","title":"atan","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]}},"sourceSpan":{"start":[18,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[18,41]}},{"children":[],"comments":"Four-quadrant tangent inverse. Given the arguments `y` and `x`, returns\nthe inverse tangent of `y / x`, where the signs of both arguments are used\nto determine the sign of the result.\nIf the first argument is negative, the result will be negative.\nThe result is the angle between the positive x axis and  a point `(x, y)`.\n","title":"atan2","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]}]}},"sourceSpan":{"start":[25,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[25,52]}},{"children":[],"comments":"Returns the smallest integer not smaller than the argument.\n","title":"ceil","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[28,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[28,40]}},{"children":[],"comments":"Returns the cosine of the argument.\n","title":"cos","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[31,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[31,40]}},{"children":[],"comments":"Returns `e` exponentiated to the power of the argument.\n","title":"exp","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[34,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[34,39]}},{"children":[],"comments":"Returns the largest integer not larger than the argument.\n","title":"floor","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[37,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[37,41]}},{"children":[],"comments":"Returns the natural logarithm of a number.\n","title":"log","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[40,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[40,39]}},{"children":[],"comments":"Returns the largest of two numbers.\n","title":"max","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}]}},"sourceSpan":{"start":[43,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[43,49]}},{"children":[],"comments":"Returns the smallest of two numbers.\n","title":"min","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}]}},"sourceSpan":{"start":[46,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[46,49]}},{"children":[],"comments":"Return  the first argument exponentiated to the power of the second argument.\n","title":"pow","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}]}},"sourceSpan":{"start":[49,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[49,49]}},{"children":[],"comments":"Returns the integer closest to the argument.\n","title":"round","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[52,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[52,41]}},{"children":[],"comments":"Returns the sine of the argument.\n","title":"sin","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[55,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[55,40]}},{"children":[],"comments":"Returns the square root of the argument.\n","title":"sqrt","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[58,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[58,40]}},{"children":[],"comments":"Returns the tangent of the argument.\n","title":"tan","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Math"],"Radians"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[61,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[61,40]}},{"children":[],"comments":"Truncates the decimal portion of a number. Equivalent to `floor` if the\nnumber is positive, and `ceil` if the number is negative.\n","title":"trunc","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}},"sourceSpan":{"start":[65,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[65,41]}},{"children":[],"comments":"Computes the remainder after division, wrapping Javascript's `%` operator.\n","title":"remainder","info":{"declType":"value","type":{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeApp","contents":[{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Function"]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]},{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}]}]}},"sourceSpan":{"start":[68,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[68,55]}},{"children":[],"comments":null,"title":"(%)","info":{"declType":"alias","alias":[["Math"],{"Right":{"Left":{"Ident":"remainder"}}}],"fixity":{"associativity":"infixl","precedence":7}},"sourceSpan":{"start":[70,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[70,24]}},{"children":[],"comments":"The base of natural logarithms, *e*, around 2.71828.\n","title":"e","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[73,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[73,27]}},{"children":[],"comments":"The natural logarithm of 2, around 0.6931.\n","title":"ln2","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[76,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[76,29]}},{"children":[],"comments":"The natural logarithm of 10, around 2.3025.\n","title":"ln10","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[79,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[79,30]}},{"children":[],"comments":"The base 2 logarithm of `e`, around 1.4426.\n","title":"log2e","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[82,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[82,31]}},{"children":[],"comments":"Base 10 logarithm of `e`, around 0.43429.\n","title":"log10e","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[85,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[85,32]}},{"children":[],"comments":"The ratio of the circumference of a circle to its diameter, around 3.14159.\n","title":"pi","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[88,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[88,28]}},{"children":[],"comments":"The ratio of the circumference of a circle to its radius, around 6.283185.\n","title":"tau","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[91,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[91,29]}},{"children":[],"comments":"The Square root of one half, around 0.707107.\n","title":"sqrt1_2","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[94,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[94,33]}},{"children":[],"comments":"The square root of two, around 1.41421.\n","title":"sqrt2","info":{"declType":"value","type":{"annotation":[],"tag":"TypeConstructor","contents":[["Prim"],"Number"]}},"sourceSpan":{"start":[97,1],"name":"../../../support/bower_components/purescript-math/src/Math.purs","end":[97,31]}}]}