API Docs for: 1.0.0
Show:

MathFunction.HyperbolicTangent Class

Extends MathFunction.FunctionWithArgs
Defined in: src/gallery-mathcanvas/js/HyperbolicTangent.js:5
Module: gallery-mathcanvas

Hyperbolic tangent.

Constructor

MathFunction.HyperbolicTangent

(
  • f
)

Defined in src/gallery-mathcanvas/js/HyperbolicTangent.js:5

Parameters:

Methods

_printArg

(
  • index
)
String protected

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:321

Print an argument, with parentheses if necessary.

Parameters:

Returns:

String:

the string representation of the argument

evaluate

(
  • var_list
)

Inherited from MathFunction but overwritten in src/gallery-mathcanvas/js/HyperbolicTangent.js:25

Parameters:

  • var_list Object

    map of variable names to values or MathFunctions

Returns:

the value of the function

evaluateArgs

(
  • var_list
)
protected

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:178

Parameters:

  • var_list Object

    map of variable names to values or MathFunctions

Returns:

list of argument values, from calling evaluate()

getArg

() MathFunction

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:68

Returns:

MathFunction:

requested argument, or undefined

getArgCount

() Int

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:59

Returns:

Int:

number of arguments

getArgs

() Array

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:78

Returns:

Array:

array of arguments

getMaxArgCount

() Int

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:47

By default, we assume the number of arguments is fixed. Derived classes can override.

Returns:

Int:

maximum number of arguments

getParent

() MathFunction

Inherited from MathFunction: src/gallery-mathcanvas/js/MathFunction.js:25

Returns:

MathFunction: parent function or null

handleKeyPress

(
  • canvas
  • code
  • c
)

Inherited from MathFunction: src/gallery-mathcanvas/js/MathFunction.js:94

Overridden by Input.

Parameters:

  • canvas MathCanvas
  • code Int
    character code
  • c String
    character

Returns:

true if function changed

insertArgAfter

(
  • f
  • after
)

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:108

Parameters:

insertArgBefore

(
  • f
  • before
)

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:87

Parameters:

layout

(
  • context
  • top_left
  • font_size
  • rect_list
)
Int

Inherited from MathFunction but overwritten in src/gallery-mathcanvas/js/FunctionWithArgs.js:193

Parameters:

  • context Object

    the drawing context

  • top_left Point

    x,y coordinates of the top left of the bounding box

  • font_size Float

    percentage of the base font size

  • rect_list RectList

    layout information

Returns:

Int:

index of this items info in rect_list

parenthesizeForPrint

(
  • f
)
Boolean protected

Inherited from MathFunction: src/gallery-mathcanvas/js/MathFunction.js:204

Parameters:

Returns:

Boolean: true if f needs to parenthesize us

parenthesizeForRender

(
  • f
)
Boolean protected

Inherited from MathFunction: src/gallery-mathcanvas/js/MathFunction.js:226

Parameters:

Returns:

Boolean: true if f needs to parenthesize us

render

(
  • context
  • rect_list
)

Inherited from MathFunction but overwritten in src/gallery-mathcanvas/js/FunctionWithArgs.js:271

Parameters:

  • context Object

    the drawing context

  • rect_list RectList

    layout information

replaceArg

(
  • origArg
  • newArg
)

Inherited from MathFunction.FunctionWithArgs: src/gallery-mathcanvas/js/FunctionWithArgs.js:155

If origArg is an argument, replaces origArg with newArg.

Parameters:

toString

()

Inherited from MathFunction but overwritten in src/gallery-mathcanvas/js/FunctionWithArgs.js:312

Returns:

text representation of the function