Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
module description of subring
Browse files Browse the repository at this point in the history
  • Loading branch information
dkrenn committed Sep 20, 2015
1 parent 15ec40e commit 7938d95
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions src/sage/symbolic/subring.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,36 @@
r"""
Subrings of the Symbolic Ring
Subrings of the symbolic ring can be created via the
:meth:`~sage.symbolic.ring.SymbolicRing.subring` method of
``SR``. This will call :class:`SymbolicSubring <SymbolicSubringFactory>`
of this module.
The following kinds of subrings are supported:
- A symbolic subring of expressions, whose variables are contained in
a given set of symbolic variables (see
:class:`SymbolicSubringAcceptingVars`). E.g.
::
sage: SR.subring(accepting_variables=('a', 'b'))
Symbolic Subring accepting the variables a, b
- A symbolic subring of expressions, whose variables are disjoint to a
given set of symbolic variables (see
:class:`SymbolicSubringRejectingVars`). E.g.
::
sage: SR.subring(rejecting_variables=('r', 's'))
Symbolic Subring rejecting the variables r, s
- The subring of symbolic constants (see
:class:`SymbolicConstantsSubring`). E.g.
::
sage: SR.subring(only_constants=True)
Symbolic Constants Subring
TESTS:
Expand Down

0 comments on commit 7938d95

Please sign in to comment.