Gnm.ExprTop

Fields

Name	Type	Access	Description
expr	Gnm.Expr	r/w
hash	int	r/w
magic	int	r/w
refcount	int	r/w

Methods

class	new (e)
class	new_array_corner (cols, rows, expr)
class	new_array_elem (x, y)
class	new_constant (v)
	as_gstring (out)
	as_string (pp, convs)
	contains_subtotal ()
	deriv (ep, info)
	equal (te2)
	eval (pos, flags)
	eval_fake_array (pos, flags)
	first_funcall ()
	get_array_expr ()
	get_array_size (cols, rows)
	get_array_value ()
	get_boundingbox (sheet, bound)
	get_cellref ()
	get_constant ()
	get_range ()
	get_ranges ()
	is_array ()
	is_array_corner ()
	is_array_elem (x, y)
	is_err (e)
	is_rangeref ()
	is_shared ()
	is_volatile ()
	multiple_as_string (pp, convs)
	ref ()
	referenced_sheets ()
	relocate (rinfo, include_rel)
	relocate_sheet (src, dst)
	transpose ()
	unref ()

Details

class Gnm.ExprTop

classmethod new(e)

Parameters:

e (Gnm.Expr) –

Return type:

Gnm.ExprTop

classmethod new_array_corner(cols, rows, expr)

Parameters:

• cols (int) –

• rows (int) –

• expr (Gnm.Expr) –

Return type:

Gnm.ExprTop

classmethod new_array_elem(x, y)

Parameters:

• x (int) –

• y (int) –

Return type:

Gnm.ExprTop

classmethod new_constant(v)

Parameters:

v (Gnm.Value) –

Return type:

Gnm.ExprTop

as_gstring(out)

Parameters:

out (Gnm.ConventionsOut) –

as_string(pp, convs)

Parameters:

• pp (Gnm.ParsePos) –

• convs (Gnm.Conventions) –

Return type:

str

contains_subtotal()

Return type:

bool

deriv(ep, info)

Parameters:

• ep (Gnm.EvalPos) – Evaluation position

• info (Gnm.ExprDeriv) – Derivative information

Returns:

The derivative of self with respect to info.

Return type:

Gnm.ExprTop or None

equal(te2)

Parameters:

te2 (Gnm.ExprTop) –

Return type:

bool

eval(pos, flags)

Parameters:

• pos (Gnm.EvalPos) –

• flags (Gnm.ExprEvalFlags) –

Return type:

Gnm.Value

eval_fake_array(pos, flags)

Parameters:

• pos (Gnm.EvalPos) –

• flags (Gnm.ExprEvalFlags) –

Return type:

Gnm.Value

first_funcall()

Return type:

Gnm.Expr

get_array_expr()

Return type:

Gnm.Expr

get_array_size(cols, rows)

Parameters:

• cols (int) –

• rows (int) –

get_array_value()

Return type:

Gnm.Value

get_boundingbox(sheet, bound)

Parameters:

• sheet (Gnm.Sheet) –

• bound (Gnm.Range) –

Returns the range of cells in which the expression can be used without going out of bounds.

get_cellref()

Return type:

Gnm.CellRef

get_constant()

Return type:

Gnm.Value

If this expression consists of just a constant, return it.

get_range()

Return type:

Gnm.Value

get_ranges()

Returns:

a list of the unique references Caller is responsible for releasing the list and the content.

Return type:

[Gnm.Range]

A collect the set of GnmRanges in expr.

is_array()

Return type:

bool

is_array_corner()

Return type:

bool

is_array_elem(x, y)

Parameters:

• x (int) –

• y (int) –

Return type:

bool

is_err(e)

Parameters:

e (Gnm.StdError) –

Return type:

bool

is_rangeref()

Return type:

bool

is_shared()

Return type:

bool

is_volatile()

Return type:

bool

multiple_as_string(pp, convs)

Parameters:

• pp (Gnm.ParsePos) –

• convs (Gnm.Conventions) –

Return type:

str

ref()

Return type:

Gnm.ExprTop

referenced_sheets()

Returns:

the created list.

Return type:

[Gnm.Sheet]

Generates a list of the sheets referenced by the supplied expression. Caller must free the list. Note, that None may occur in the result if the expression has a range or cellref without a sheet.

relocate(rinfo, include_rel)

Parameters:

• rinfo (Gnm.ExprRelocateInfo) –

• include_rel (bool) –

Return type:

Gnm.ExprTop

relocate_sheet(src, dst)

Parameters:

• src (Gnm.Sheet) –

• dst (Gnm.Sheet) –

Return type:

Gnm.ExprTop

transpose()

Return type:

Gnm.ExprTop

unref()