core.base_calculus.Function Class Reference

It's all the f(x), cos(x) etc. More...

Inheritance diagram for core.base_calculus.Function:

List of all members.

Public Member Functions
def	__init__
	Constructor.
def	get_variable
	Returns the variable as a String.
def	get_numeric_value
	Returns the numeric Value to replace the variable with.
def	get_displayed_value
	Returns either the variable or the numeric value to display.
def	get_internal_expression
	Returns the expression used to evaluate the Function.
def	set_numeric_value
	Sets the numeric Value to replace the variable with.
def	swap_to_literal
	Sets the displayed value to the literal one.
def	swap_to_numeric
	Sets the displayed value to the numeric one.
def	is_displ_as_a_single_1
	Always False.
def	is_displ_as_a_single_int
	True if the object can be displayed as a single int.
def	is_displ_as_a_single_minus_1
	Always False.
def	is_displ_as_a_single_0
	Always False.
def	is_displ_as_a_single_numeric_Item
	Always False.
def	is_expandable
	False.
Properties
	numeric_value
	variable
	displayed_value
	internal_expression

---

Detailed Description

It's all the f(x), cos(x) etc.

with only one variable at the moment

Definition at line 1133 of file base_calculus.py.

---

Constructor & Destructor Documentation

def core.base_calculus.Function.__init__	(		self,
			arg
	)

Constructor.

Warning:

Might raise an UncompatibleType exception.

Parameters:

arg

(String, literalCalculable|Angle, None|math.function()|Calculable, None|math.function()|Calculable) The first String will be the name of the function, the second arg will give the variable String The third argument can be either None (if None is needed), a function of the math module, or a Calculable The fourth one can be of the same type as the third one ; this is meant to be the inverse function of the third one

Returns:

One instance of Function

Reimplemented from core.base_calculus.Item.

Definition at line 1154 of file base_calculus.py.

References core.base_calculus.Function._displayed_value, core.base_calculus.Item._exponent, core.base_calculus.Function._exponent, core.base_calculus.Item._force_display_sign_once, core.base_calculus.Function._force_display_sign_once, core.base_calculus.Function._internal_expression, core.base_calculus.Item._is_out_striked, core.base_calculus.Function._is_out_striked, core.base.NamedObject._name, core.base_calculus.Function._name, core.base_calculus.Function._numeric_value, core.base_calculus.Function._reverse_expression, core.base_calculus.Item._sign, core.base_calculus.Function._sign, core.base_calculus.Item._unit, core.base_calculus.Function._unit, core.base_calculus.Item._value_inside, core.base_calculus.Function._value_inside, core.base_calculus.Function._variable, and core.base_calculus.Item.is_literal().

Referenced by core.calculus.Equation.__init__(), and core.root_calculus.Value.substitute().

---

Member Function Documentation

def core.base_calculus.Function.is_expandable

(

self

)

False.

Returns:

False

Reimplemented from core.base_calculus.Item.

Reimplemented in core.base_calculus.SquareRoot.

Definition at line 1357 of file base_calculus.py.

def core.base_calculus.Function.swap_to_literal

(

self

)

Sets the displayed value to the literal one.

Returns:

Nothing

Definition at line 1285 of file base_calculus.py.

References core.base_calculus.Function._displayed_value, and core.base_calculus.Function._variable.

def core.base_calculus.Function.swap_to_numeric

(

self

)

Sets the displayed value to the numeric one.

Returns:

Nothing

Definition at line 1296 of file base_calculus.py.

References core.base_calculus.Function._displayed_value, and core.base_calculus.Function._numeric_value.

---

Property Documentation

core::base_calculus.Function::displayed_value [static]

Initial value:

property(get_displayed_value,
                               doc = "Value to display (variable or numeric)")

Definition at line 1255 of file base_calculus.py.

core::base_calculus.Function::internal_expression [static]

Initial value:

property(get_internal_expression,
                                   doc = "Used to evaluate the Function")

Definition at line 1258 of file base_calculus.py.

core::base_calculus.Function::numeric_value [static]

Initial value:

property(get_numeric_value,
                             doc = "Value to use to replace the variable"\
                                   " (e.g. '9' or '60\textdegree'...)")

Definition at line 1247 of file base_calculus.py.

core::base_calculus.Function::variable [static]

Initial value:

property(get_variable,
                        doc = "Variable of the Function"\
                              " (e.g. 'x' or '\widehat{ABC}'...)")

Definition at line 1251 of file base_calculus.py.

---

The documentation for this class was generated from the following file:

• mamk_misc/doc/mathmaker4doxygen/core/base_calculus.py