/

# Assumptions module¶

## Contents¶

Method for inferring properties about objects.

Syntax

where proposition is any boolean expression

Examples

>>> from sympy import ask, Q, pi
>>> from sympy.abc import x, y
False
True
False
Remarks

Relations in assumptions are not implemented (yet), so the following will not give a meaningful result.

It is however a work in progress.

## Querying¶

ask’s optional second argument should be a boolean expression involving assumptions about objects in expr. Valid values include:

• Q.integer(x)
• Q.positive(x)
• Q.integer(x) & Q.positive(x)
• etc.

Q is a class in sympy.assumptions holding known predicates.

See documentation for the logic module for a complete list of valid boolean expressions.

You can also define a context so you don’t have to pass that argument each time to function ask(). This is done by using the assuming context manager from module sympy.assumptions.

>>> from sympy import *
>>> x = Symbol('x')
>>> y = Symbol('y')
>>> facts = Q.positive(x), Q.positive(y)
>>> with assuming(*facts):
True

## Supported predicates¶

### bounded¶

Test that a function is bounded with respect to its variables. For example, sin(x) is a bounded functions, but exp(x) is not.

Examples:

>>> from sympy import *
>>> x = Symbol('x')
False
True
True

### commutative¶

Test that objects are commutative. By default, symbols in SymPy are considered commutative except otherwise stated.

Examples:

>>> from sympy import *
>>> x, y = symbols('x,y')
True
False
False

### complex¶

Test that expression belongs to the field of complex numbers.

Examples:

>>> from sympy import *
True
True
>>> x, y = symbols('x,y')
True

### even¶

Test that expression represents an even number, that is, an number that can be written in the form 2*n, n integer.

Examples:

>>> from sympy import *
True
>>> n = Symbol('n')
True

### extended_real¶

Test that an expression belongs to the field of extended real numbers, that is, real numbers union {Infinity, -Infinity}.

Examples:

>>> from sympy import *
True
True
True

### imaginary¶

Test that an expression belongs to the set of imaginary numbers, that is,
it can be written as x*I, where x is real and I is the imaginary unit.

Examples:

>>> from sympy import *
True
>>> x = Symbol('x')
True

### infinitesimal¶

Test that an expression is equivalent to an infinitesimal number.

Examples:

>>> from sympy import *
True
>>> x, y = symbols('x,y')
True
True

### integer¶

Test that an expression belongs to the set of integer numbers.

Examples:

>>> from sympy import *
True
False
>>> x = Symbol('x')
True

### irrational¶

Test that an expression represents an irrational number.

Examples:

>>> from sympy import *
True
True
True

### rational¶

Test that an expression represents a rational number.

Examples:

>>> from sympy import *
True
>>> x, y = symbols('x,y')
True
True

### negative¶

Test that an expression is less (strict) than zero.

Examples:

>>> from sympy import *
False
>>> x = Symbol('x')
True

#### Remarks¶

negative numbers are defined as real numbers that are not zero nor positive, so complex numbers (with nontrivial imaginary coefficients) will return False for this predicate. The same applies to Q.positive.

### positive¶

Test that a given expression is greater (strict) than zero.

Examples:

>>> from sympy import *
True
>>> x = Symbol('x')
True

#### Remarks¶

see Remarks for negative

### prime¶

Test that an expression represents a prime number.

Examples:

>>> from sympy import *
True

Remarks: Use sympy.ntheory.isprime to test numeric values efficiently.

### real¶

Test that an expression belongs to the field of real numbers.

Examples:

>>> from sympy import *
True
>>> x, y = symbols('x,y')
True

### odd¶

Test that an expression represents an odd number.

Examples:

>>> from sympy import *
True
>>> n = Symbol('n')
True

### nonzero¶

Test that an expression is not zero.

Examples:

>>> from sympy import *
>>> x = Symbol('x')
True

## Design¶

Each time ask is called, the appropriate Handler for the current key is called. This is always a subclass of sympy.assumptions.AskHandler. It’s classmethods have the name’s of the classes it supports. For example, a (simplified) AskHandler for the ask ‘positive’ would look like this:

def Mul(self):
# return True if all argument's in self.expr.args are positive
...

for arg in self.expr.args:
break
else:
# if all argument's are positive
return True
...

The .Mul() method is called when self.expr is an instance of Mul, the Add method would be called when self.expr is an instance of Add and so on.

## Extensibility¶

You can define new queries or support new types by subclassing sympy.assumptions.AskHandler
and registering that handler for a particular key by calling register_handler:

Register a handler in the ask system. key must be a string and handler a class inheriting from AskHandler:

>>> from sympy.assumptions import register_handler, ask, Q
...     # Mersenne numbers are in the form 2**n + 1, n integer
...     @staticmethod
...     def Integer(expr, assumptions):
...         import math
...         return ask(Q.integer(math.log(expr + 1, 2)))
>>> register_handler('mersenne', MersenneHandler)
True

You can undo this operation by calling remove_handler.

Removes a handler from the ask system. Same syntax as register_handler

You can support new types [1] by adding a handler to an existing key. In the following example, we will create a new type MyType and extend the key ‘prime’ to accept this type (and return True)

>>> from sympy.core import Basic
>>> from sympy.assumptions import register_handler
>>> class MyType(Basic):
...     pass
...     @staticmethod
...     def MyType(expr, assumptions):
...         return True
>>> a = MyType()
True

## Performance improvements¶

On queries that involve symbolic coefficients, logical inference is used. Work on improving satisfiable function (sympy.logic.inference.satisfiable) should result in notable speed improvements.

Logic inference used in one ask could be used to speed up further queries, and current system does not take advantage of this. For example, a truth maintenance system (http://en.wikipedia.org/wiki/Truth_maintenance_system) could be implemented.

## Misc¶

You can find more examples in the in the form of test under directory sympy/assumptions/tests/

 [1] New type must inherit from Basic, otherwise an exception will be raised. This is a bug and should be fixed.