r"""
Convex rational polyhedral cones
This module was designed as a part of framework for toric varieties
(:mod:`~sage.schemes.toric.variety`,
:mod:`~sage.schemes.toric.fano_variety`). While the emphasis is on
strictly convex cones, non-strictly convex cones are supported as well. Work
with distinct lattices (in the sense of discrete subgroups spanning vector
spaces) is supported. The default lattice is :class:`ToricLattice
<sage.geometry.toric_lattice.ToricLatticeFactory>` `N` of the appropriate
dimension. The only case when you must specify lattice explicitly is creation
of a 0-dimensional cone, where dimension of the ambient space cannot be
guessed.
AUTHORS:
- Andrey Novoseltsev (2010-05-13): initial version.
- Andrey Novoseltsev (2010-06-17): substantial improvement during review by
Volker Braun.
- Volker Braun (2010-06-21): various spanned/quotient/dual lattice
computations added.
- Volker Braun (2010-12-28): Hilbert basis for cones.
- Andrey Novoseltsev (2012-02-23): switch to PointCollection container.
EXAMPLES:
Use :func:`Cone` to construct cones::
sage: octant = Cone([(1,0,0), (0,1,0), (0,0,1)])
sage: halfspace = Cone([(1,0,0), (0,1,0), (-1,-1,0), (0,0,1)])
sage: positive_xy = Cone([(1,0,0), (0,1,0)])
sage: four_rays = Cone([(1,1,1), (1,-1,1), (-1,-1,1), (-1,1,1)])
For all of the cones above we have provided primitive generating rays, but in
fact this is not necessary - a cone can be constructed from any collection of
rays (from the same space, of course). If there are non-primitive (or even
non-integral) rays, they will be replaced with primitive ones. If there are
extra rays, they will be discarded. Of course, this means that :func:`Cone`
has to do some work before actually constructing the cone and sometimes it is
not desirable, if you know for sure that your input is already "good". In this
case you can use options ``check=False`` to force :func:`Cone` to use
exactly the directions that you have specified and ``normalize=False`` to
force it to use exactly the rays that you have specified. However, it is
better not to use these possibilities without necessity, since cones are
assumed to be represented by a minimal set of primitive generating rays.
See :func:`Cone` for further documentation on construction.
Once you have a cone, you can perform numerous operations on it. The most
important ones are, probably, ray accessing methods::
sage: rays = halfspace.rays()
sage: rays
N( 0, 0, 1),
N( 0, 1, 0),
N( 0, -1, 0),
N( 1, 0, 0),
N(-1, 0, 0)
in 3-d lattice N
sage: rays.set()
frozenset([N(1, 0, 0), N(-1, 0, 0), N(0, 1, 0), N(0, 0, 1), N(0, -1, 0)])
sage: rays.matrix()
[ 0 0 1]
[ 0 1 0]
[ 0 -1 0]
[ 1 0 0]
[-1 0 0]
sage: rays.column_matrix()
[ 0 0 0 1 -1]
[ 0 1 -1 0 0]
[ 1 0 0 0 0]
sage: rays(3)
N(1, 0, 0)
in 3-d lattice N
sage: rays[3]
N(1, 0, 0)
sage: halfspace.ray(3)
N(1, 0, 0)
The method :meth:`~IntegralRayCollection.rays` returns a
:class:`~sage.geometry.point_collection.PointCollection` with the
`i`-th element being the primitive integral generator of the `i`-th
ray. It is possible to convert this collection to a matrix with either
rows or columns corresponding to these generators. You may also change
the default
:meth:`~sage.geometry.point_collection.PointCollection.output_format`
of all point collections to be such a matrix.
If you want to do something with each ray of a cone, you can write ::
sage: for ray in positive_xy: print ray
N(1, 0, 0)
N(0, 1, 0)
There are two dimensions associated to each cone - the dimension of the
subspace spanned by the cone and the dimension of the space where it lives::
sage: positive_xy.dim()
2
sage: positive_xy.lattice_dim()
3
You also may be interested in this dimension::
sage: dim(positive_xy.linear_subspace())
0
sage: dim(halfspace.linear_subspace())
2
Or, perhaps, all you care about is whether it is zero or not::
sage: positive_xy.is_strictly_convex()
True
sage: halfspace.is_strictly_convex()
False
You can also perform these checks::
sage: positive_xy.is_simplicial()
True
sage: four_rays.is_simplicial()
False
sage: positive_xy.is_smooth()
True
You can work with subcones that form faces of other cones::
sage: face = four_rays.faces(dim=2)[0]
sage: face
2-d face of 3-d cone in 3-d lattice N
sage: face.rays()
N(1, 1, 1),
N(1, -1, 1)
in 3-d lattice N
sage: face.ambient_ray_indices()
(0, 1)
sage: four_rays.rays(face.ambient_ray_indices())
N(1, 1, 1),
N(1, -1, 1)
in 3-d lattice N
If you need to know inclusion relations between faces, you can use ::
sage: L = four_rays.face_lattice()
sage: map(len, L.level_sets())
[1, 4, 4, 1]
sage: face = L.level_sets()[2][0]
sage: face.rays()
N(1, 1, 1),
N(1, -1, 1)
in 3-d lattice N
sage: L.hasse_diagram().neighbors_in(face)
[1-d face of 3-d cone in 3-d lattice N,
1-d face of 3-d cone in 3-d lattice N]
.. WARNING::
The order of faces in level sets of
the face lattice may differ from the order of faces returned by
:meth:`~ConvexRationalPolyhedralCone.faces`. While the first order is
random, the latter one ensures that one-dimensional faces are listed in
the same order as generating rays.
When all the functionality provided by cones is not enough, you may want to
check if you can do necessary things using lattice polytopes and polyhedra
corresponding to cones::
sage: four_rays.lattice_polytope()
A lattice polytope: 3-dimensional, 5 vertices.
sage: four_rays.polyhedron()
A 3-dimensional polyhedron in ZZ^3 defined as
the convex hull of 1 vertex and 4 rays
And of course you are always welcome to suggest new features that should be
added to cones!
REFERENCES:
.. [Fulton]
Wiliam Fulton, "Introduction to Toric Varieties", Princeton
University Press
"""
import collections
import copy
import warnings
from sage.combinat.posets.posets import FinitePoset
from sage.geometry.lattice_polytope import LatticePolytope, integral_length
from sage.geometry.point_collection import PointCollection
from sage.geometry.polyhedron.constructor import Polyhedron
from sage.geometry.polyhedron.base import is_Polyhedron
from sage.geometry.hasse_diagram import Hasse_diagram_from_incidences
from sage.geometry.toric_lattice import ToricLattice, is_ToricLattice, \
is_ToricLatticeQuotient
from sage.geometry.toric_plotter import ToricPlotter, label_list
from sage.graphs.digraph import DiGraph
from sage.matrix.all import matrix, identity_matrix
from sage.misc.all import cached_method, flatten, latex, prod
from sage.misc.superseded import deprecation
from sage.modules.all import span, vector
from sage.rings.all import QQ, RR, ZZ, gcd
from sage.structure.all import SageObject
from sage.structure.coerce import parent
from sage.libs.ppl import C_Polyhedron, Generator_System, Constraint_System, \
Linear_Expression, ray as PPL_ray, point as PPL_point, \
Poly_Con_Relation
from sage.geometry.integral_points import parallelotope_points
def is_Cone(x):
r"""
Check if ``x`` is a cone.
INPUT:
- ``x`` -- anything.
OUTPUT:
- ``True`` if ``x`` is a cone and ``False`` otherwise.
EXAMPLES::
sage: from sage.geometry.cone import is_Cone
sage: is_Cone(1)
False
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant
2-d cone in 2-d lattice N
sage: is_Cone(quadrant)
True
"""
return isinstance(x, ConvexRationalPolyhedralCone)
def Cone(rays, lattice=None, check=True, normalize=True):
r"""
Construct a (not necessarily strictly) convex rational polyhedral cone.
INPUT:
- ``rays`` -- a list of rays. Each ray should be given as a list
or a vector convertible to the rational extension of the given
``lattice``. May also be specified by a
:class:`~sage.geometry.polyhedron.base.Polyhedron_base` object;
- ``lattice`` -- :class:`ToricLattice
<sage.geometry.toric_lattice.ToricLatticeFactory>`, `\ZZ^n`, or any
other object that behaves like these. If not specified, an attempt will
be made to determine an appropriate toric lattice automatically;
- ``check`` -- by default the input data will be checked for
correctness (e.g. that all rays have the same number of
components) and generating rays will be constructed from
``rays``. If you know that the input is a minimal set of
generators of a valid cone, you may significantly decrease
construction time using ``check=False`` option;
- ``normalize`` -- you can further speed up construction using
``normalize=False`` option. In this case ``rays`` must be a list of
immutable primitive rays in ``lattice``. In general, you should not use
this option, it is designed for code optimization and does not give as
drastic improvement in speed as the previous one.
OUTPUT:
- convex rational polyhedral cone determined by ``rays``.
EXAMPLES:
Let's define a cone corresponding to the first quadrant of the plane
(note, you can even mix objects of different types to represent rays, as
long as you let this function to perform all the checks and necessary
conversions!)::
sage: quadrant = Cone([(1,0), [0,1]])
sage: quadrant
2-d cone in 2-d lattice N
sage: quadrant.rays()
N(1, 0),
N(0, 1)
in 2-d lattice N
If you give more rays than necessary, the extra ones will be discarded::
sage: Cone([(1,0), (0,1), (1,1), (0,1)]).rays()
N(0, 1),
N(1, 0)
in 2-d lattice N
However, this work is not done with ``check=False`` option, so use it
carefully! ::
sage: Cone([(1,0), (0,1), (1,1), (0,1)], check=False).rays()
N(1, 0),
N(0, 1),
N(1, 1),
N(0, 1)
in 2-d lattice N
Even worse things can happen with ``normalize=False`` option::
sage: Cone([(1,0), (0,1)], check=False, normalize=False)
Traceback (most recent call last):
...
AttributeError: 'tuple' object has no attribute 'parent'
You can construct different "not" cones: not full-dimensional, not
strictly convex, not containing any rays::
sage: one_dimensional_cone = Cone([(1,0)])
sage: one_dimensional_cone.dim()
1
sage: half_plane = Cone([(1,0), (0,1), (-1,0)])
sage: half_plane.rays()
N( 0, 1),
N( 1, 0),
N(-1, 0)
in 2-d lattice N
sage: half_plane.is_strictly_convex()
False
sage: origin = Cone([(0,0)])
sage: origin.rays()
Empty collection
in 2-d lattice N
sage: origin.dim()
0
sage: origin.lattice_dim()
2
You may construct the cone above without giving any rays, but in this case
you must provide ``lattice`` explicitly::
sage: origin = Cone([])
Traceback (most recent call last):
...
ValueError: lattice must be given explicitly if there are no rays!
sage: origin = Cone([], lattice=ToricLattice(2))
sage: origin.dim()
0
sage: origin.lattice_dim()
2
sage: origin.lattice()
2-d lattice N
Of course, you can also provide ``lattice`` in other cases::
sage: L = ToricLattice(3, "L")
sage: c1 = Cone([(1,0,0),(1,1,1)], lattice=L)
sage: c1.rays()
L(1, 0, 0),
L(1, 1, 1)
in 3-d lattice L
Or you can construct cones from rays of a particular lattice::
sage: ray1 = L(1,0,0)
sage: ray2 = L(1,1,1)
sage: c2 = Cone([ray1, ray2])
sage: c2.rays()
L(1, 0, 0),
L(1, 1, 1)
in 3-d lattice L
sage: c1 == c2
True
When the cone in question is not strictly convex, the standard form for
the "generating rays" of the linear subspace is "basis vectors and their
negatives", as in the following example::
sage: plane = Cone([(1,0), (0,1), (-1,-1)])
sage: plane.rays()
N( 0, 1),
N( 0, -1),
N( 1, 0),
N(-1, 0)
in 2-d lattice N
The cone can also be specified by a
:class:`~sage.geometry.polyhedron.base.Polyhedron_base`::
sage: p = plane.polyhedron()
sage: Cone(p)
2-d cone in 2-d lattice N
sage: Cone(p) == plane
True
TESTS::
sage: N = ToricLattice(2)
sage: Nsub = N.span([ N(1,2) ])
sage: Cone(Nsub.basis())
1-d cone in Sublattice <N(1, 2)>
sage: Cone([N(0)])
0-d cone in 2-d lattice N
"""
if is_Polyhedron(rays):
polyhedron = rays
if lattice is None:
lattice = ToricLattice(polyhedron.ambient_dim())
if polyhedron.n_vertices() > 1:
raise ValueError("%s is not a cone!" % polyhedron)
apex = polyhedron.vertices()[0]
if apex.count(0) != len(apex):
raise ValueError("the apex of %s is not at the origin!"
% polyhedron)
rays = normalize_rays(polyhedron.rays(), lattice)
for line in normalize_rays(polyhedron.lines(), lattice):
rays.append(line)
rays.append(-line)
rays[-1].set_immutable()
return ConvexRationalPolyhedralCone(rays, lattice)
if check or normalize:
rays = normalize_rays(rays, lattice)
if lattice is None:
if rays:
lattice = rays[0].parent()
else:
raise ValueError(
"lattice must be given explicitly if there are no rays!")
if not check or not rays:
return ConvexRationalPolyhedralCone(rays, lattice)
if is_ToricLatticeQuotient(lattice):
gs = Generator_System(
PPL_point(Linear_Expression(lattice(0).vector(), 0)))
for r in rays:
if not r.is_zero():
gs.insert(PPL_ray(Linear_Expression(r.vector(), 0)))
else:
gs = Generator_System( PPL_point(Linear_Expression(lattice(0),0)) )
for r in rays:
if not r.is_zero():
gs.insert( PPL_ray(Linear_Expression(r,0)) )
cone = C_Polyhedron(gs)
return _Cone_from_PPL(cone, lattice, rays)
def _Cone_from_PPL(cone, lattice, original_rays=None):
"""
Construct a cone from a :class:`~sage.libs.ppl.Polyhedron`.
This is a private function and not intended to be exposed to the
end user. It is used internally by :func:`Cone` and in
:meth:`ConvexRationalPolyhedralCone.intersection`.
INPUT:
- ``cone`` -- a :class:`~sage.libs.ppl.Polyhedron` having the
origin as its single point.
- ``lattice`` -- :class:`ToricLattice
<sage.geometry.toric_lattice.ToricLatticeFactory>`, `\ZZ^n`, or any
other object that behaves like these.
- ``original_rays`` -- (default: ``None``) if given, must be a minimal list
of normalized generating rays of ``cone``. If ``cone`` is strictly convex
and ``original_rays`` were given, they will be used as internal rays of
the constructed cone, in the given order.
OUTPUT:
A :class:`ConvexRationalPolyhedralCone`.
TESTS::
sage: Cone([(1,0), (0,1), (1,1), (0,1)]).rays() # indirect doctest
N(0, 1),
N(1, 0)
in 2-d lattice N
"""
rays = []
lines = []
for g in cone.minimized_generators():
if g.is_ray():
rays.append(g)
if g.is_line():
lines.append(g)
if (original_rays is not None and not lines and
len(rays) == len(original_rays)):
return ConvexRationalPolyhedralCone(original_rays, lattice, PPL=cone)
else:
rays = [ray.coefficients() for ray in rays]
for line in lines:
rays.append(line.coefficients())
rays.append(-vector(ZZ, rays[-1]))
try:
for i, ray in enumerate(rays):
rays[i] = lattice(ray)
rays[i].set_immutable()
except TypeError:
rays = normalize_rays(rays, lattice)
return ConvexRationalPolyhedralCone(rays, lattice, PPL=cone)
def normalize_rays(rays, lattice):
r"""
Normalize a list of rational rays: make them primitive and immutable.
INPUT:
- ``rays`` -- list of rays which can be converted to the rational
extension of ``lattice``;
- ``lattice`` -- :class:`ToricLattice
<sage.geometry.toric_lattice.ToricLatticeFactory>`, `\ZZ^n`, or any
other object that behaves like these. If ``None``, an attempt will
be made to determine an appropriate toric lattice automatically.
OUTPUT:
- list of immutable primitive vectors of the ``lattice`` in the same
directions as original ``rays``.
EXAMPLES::
sage: from sage.geometry.cone import normalize_rays
sage: normalize_rays([(0, 1), (0, 2), (3, 2), (5/7, 10/3)], None)
[N(0, 1), N(0, 1), N(3, 2), N(3, 14)]
sage: L = ToricLattice(2, "L")
sage: normalize_rays([(0, 1), (0, 2), (3, 2), (5/7, 10/3)], L.dual())
[L*(0, 1), L*(0, 1), L*(3, 2), L*(3, 14)]
sage: ray_in_L = L(0,1)
sage: normalize_rays([ray_in_L, (0, 2), (3, 2), (5/7, 10/3)], None)
[L(0, 1), L(0, 1), L(3, 2), L(3, 14)]
sage: normalize_rays([(0, 1), (0, 2), (3, 2), (5/7, 10/3)], ZZ^2)
[(0, 1), (0, 1), (3, 2), (3, 14)]
sage: normalize_rays([(0, 1), (0, 2), (3, 2), (5/7, 10/3)], ZZ^3)
Traceback (most recent call last):
...
TypeError: cannot convert (0, 1) to
Vector space of dimension 3 over Rational Field!
sage: normalize_rays([], ZZ^3)
[]
"""
if rays is None:
rays = []
try:
rays = list(rays)
except TypeError:
raise TypeError(
"rays must be given as a list or a compatible structure!"
"\nGot: %s" % rays)
if rays:
if lattice is None:
ray_parent = parent(rays[0])
lattice = (ray_parent if is_ToricLattice(ray_parent)
else ToricLattice(len(rays[0])))
if lattice.base_ring() is not ZZ:
raise TypeError("lattice must be a free module over ZZ")
try:
if not lattice.is_torsion_free():
raise ValueError("cannot normalize rays of torsion quotients!")
except AttributeError:
pass
V = None
try:
if lattice.is_ambient():
V = lattice.base_extend(QQ)
length = lambda ray: integral_length(ray)
except AttributeError:
pass
if V is None:
V = lattice.vector_space_span_of_basis(lattice.basis())
length = lambda ray: integral_length(V.coordinate_vector(ray))
for n, ray in enumerate(rays):
try:
if isinstance(ray, (list, tuple, V._element_class)):
ray = V(ray)
else:
ray = V(list(ray))
except TypeError:
raise TypeError("cannot convert %s to %s!" % (ray, V))
if ray.is_zero():
ray = lattice(0)
else:
ray = lattice(ray / length(ray))
ray.set_immutable()
rays[n] = ray
return rays
class IntegralRayCollection(SageObject,
collections.Hashable,
collections.Iterable):
r"""
Create a collection of integral rays.
.. WARNING::
No correctness check or normalization is performed on the input data.
This class is designed for internal operations and you probably should
not use it directly.
This is a base class for :class:`convex rational polyhedral cones
<ConvexRationalPolyhedralCone>` and :class:`fans
<sage.geometry.fan.RationalPolyhedralFan>`.
Ray collections are immutable, but they cache most of the returned values.
INPUT:
- ``rays`` -- list of immutable vectors in ``lattice``;
- ``lattice`` -- :class:`ToricLattice
<sage.geometry.toric_lattice.ToricLatticeFactory>`, `\ZZ^n`, or any
other object that behaves like these. If ``None``, it will be determined
as :func:`parent` of the first ray. Of course, this cannot be done if
there are no rays, so in this case you must give an appropriate
``lattice`` directly. Note that ``None`` is *not* the default value -
you always *must* give this argument explicitly, even if it is ``None``.
OUTPUT:
- collection of given integral rays.
"""
def __init__(self, rays, lattice):
r"""
See :class:`IntegralRayCollection` for documentation.
TESTS::
sage: from sage.geometry.cone import (
... IntegralRayCollection)
sage: v = vector([1,0])
sage: v.set_immutable()
sage: c = IntegralRayCollection([v], ZZ^2)
sage: c = IntegralRayCollection([v], None)
sage: c.lattice() # Determined automatically
Ambient free module of rank 2
over the principal ideal domain Integer Ring
sage: c.rays()
(1, 0)
in Ambient free module of rank 2
over the principal ideal domain Integer Ring
sage: TestSuite(c).run()
"""
if lattice is None:
lattice = rays[0].parent()
self._rays = PointCollection(rays, lattice)
self._lattice = lattice
def __cmp__(self, right):
r"""
Compare ``self`` and ``right``.
INPUT:
- ``right`` -- anything.
OUTPUT:
- 0 if ``right`` is of the same type as ``self``, they have the same
ambient lattices, and their rays are the same and listed in the same
order. 1 or -1 otherwise.
TESTS::
sage: c1 = Cone([(1,0), (0,1)])
sage: c2 = Cone([(0,1), (1,0)])
sage: c3 = Cone([(0,1), (1,0)])
sage: cmp(c1, c2)
1
sage: cmp(c2, c1)
-1
sage: cmp(c2, c3)
0
sage: c2 is c3
False
sage: cmp(c1, 1) * cmp(1, c1)
-1
"""
c = cmp(type(self), type(right))
if c:
return c
return cmp((self.lattice(), self.rays()),
(right.lattice(), right.rays()))
def __hash__(self):
r"""
Return the hash of ``self`` computed from rays.
OUTPUT:
- integer.
TESTS::
sage: c = Cone([(1,0), (0,1)])
sage: hash(c) == hash(c)
True
"""
if "_hash" not in self.__dict__:
self._hash = hash(self._rays)
return self._hash
def __iter__(self):
r"""
Return an iterator over rays of ``self``.
OUTPUT:
- iterator.
TESTS::
sage: c = Cone([(1,0), (0,1)])
sage: for ray in c: print ray
N(1, 0)
N(0, 1)
"""
return iter(self._rays)
def _ambient_space_point(self, data):
r"""
Try to convert ``data`` to a point of the ambient space of ``self``.
INPUT:
- ``data`` -- anything.
OUTPUT:
- integral, rational or numeric point of the ambient space of ``self``
if ``data`` were successfully interpreted in such a way, otherwise a
``TypeError`` exception is raised.
TESTS::
sage: c = Cone([(1,0), (0,1)])
sage: c._ambient_space_point([1,1])
N(1, 1)
sage: c._ambient_space_point(c.dual_lattice()([1,1]))
Traceback (most recent call last):
...
TypeError: the point M(1, 1) and
2-d cone in 2-d lattice N have incompatible lattices!
sage: c._ambient_space_point([1,1/3])
(1, 1/3)
sage: c._ambient_space_point([1/2,1/sqrt(3)])
(0.500000000000000, 0.577350269189626)
sage: c._ambient_space_point([1,1,3])
Traceback (most recent call last):
...
TypeError: [1, 1, 3] does not represent a valid point
in the ambient space of 2-d cone in 2-d lattice N!
"""
L = self.lattice()
try:
return L(data)
except TypeError:
if is_ToricLattice(parent(data)):
raise TypeError("the point %s and %s have incompatible "
"lattices!" % (data, self))
try:
return L.base_extend(QQ)(data)
except TypeError:
pass
try:
return L.base_extend(RR)(data)
except TypeError:
pass
raise TypeError("%s does not represent a valid point in the ambient "
"space of %s!" % (data, self))
def cartesian_product(self, other, lattice=None):
r"""
Return the Cartesian product of ``self`` with ``other``.
INPUT:
- ``other`` -- an :class:`IntegralRayCollection`;
- ``lattice`` -- (optional) the ambient lattice for the result. By
default, the direct sum of the ambient lattices of ``self`` and
``other`` is constructed.
OUTPUT:
- an :class:`IntegralRayCollection`.
By the Cartesian product of ray collections `(r_0, \dots, r_{n-1})` and
`(s_0, \dots, s_{m-1})` we understand the ray collection of the form
`((r_0, 0), \dots, (r_{n-1}, 0), (0, s_0), \dots, (0, s_{m-1}))`, which
is suitable for Cartesian products of cones and fans. The ray order is
guaranteed to be as described.
EXAMPLES::
sage: c = Cone([(1,)])
sage: c.cartesian_product(c) # indirect doctest
2-d cone in 2-d lattice N+N
sage: _.rays()
N+N(1, 0),
N+N(0, 1)
in 2-d lattice N+N
"""
assert isinstance(other, IntegralRayCollection)
if lattice is None:
lattice = self.lattice().direct_sum(other.lattice())
suffix = [0] * other.lattice_dim()
rays = [lattice(list(r1) + suffix) for r1 in self.rays()]
prefix = [0] * self.lattice_dim()
rays.extend(lattice(prefix + list(r2)) for r2 in other.rays())
for r in rays:
r.set_immutable()
return IntegralRayCollection(rays, lattice)
def dim(self):
r"""
Return the dimension of the subspace spanned by rays of ``self``.
OUTPUT:
- integer.
EXAMPLES::
sage: c = Cone([(1,0)])
sage: c.lattice_dim()
2
sage: c.dim()
1
"""
if "_dim" not in self.__dict__:
self._dim = self.rays().matrix().rank()
return self._dim
def lattice(self):
r"""
Return the ambient lattice of ``self``.
OUTPUT:
- lattice.
EXAMPLES::
sage: c = Cone([(1,0)])
sage: c.lattice()
2-d lattice N
sage: Cone([], ZZ^3).lattice()
Ambient free module of rank 3
over the principal ideal domain Integer Ring
"""
return self._lattice
def dual_lattice(self):
r"""
Return the dual of the ambient lattice of ``self``.
OUTPUT:
- lattice. If possible (that is, if :meth:`lattice` has a
``dual()`` method), the dual lattice is returned. Otherwise,
`\ZZ^n` is returned, where `n` is the dimension of ``self``.
EXAMPLES::
sage: c = Cone([(1,0)])
sage: c.dual_lattice()
2-d lattice M
sage: Cone([], ZZ^3).dual_lattice()
Ambient free module of rank 3
over the principal ideal domain Integer Ring
"""
if '_dual_lattice' not in self.__dict__:
try:
self._dual_lattice = self.lattice().dual()
except AttributeError:
self._dual_lattice = ZZ**self.lattice_dim()
return self._dual_lattice
def lattice_dim(self):
r"""
Return the dimension of the ambient lattice of ``self``.
OUTPUT:
- integer.
EXAMPLES::
sage: c = Cone([(1,0)])
sage: c.lattice_dim()
2
sage: c.dim()
1
"""
return self.lattice().dimension()
def nrays(self):
r"""
Return the number of rays of ``self``.
OUTPUT:
- integer.
EXAMPLES::
sage: c = Cone([(1,0), (0,1)])
sage: c.nrays()
2
"""
return len(self._rays)
def plot(self, **options):
r"""
Plot ``self``.
INPUT:
- any options for toric plots (see :func:`toric_plotter.options
<sage.geometry.toric_plotter.options>`), none are mandatory.
OUTPUT:
- a plot.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant.plot()
"""
tp = ToricPlotter(options, self.lattice().degree(), self.rays())
return tp.plot_lattice() + tp.plot_rays() + tp.plot_generators()
def ray(self, n):
r"""
Return the ``n``-th ray of ``self``.
INPUT:
- ``n`` -- integer, an index of a ray of ``self``. Enumeration of rays
starts with zero.
OUTPUT:
- ray, an element of the lattice of ``self``.
EXAMPLES::
sage: c = Cone([(1,0), (0,1)])
sage: c.ray(0)
N(1, 0)
"""
return self._rays[n]
def ray_iterator(self, ray_list=None):
r"""
Return an iterator over (some of) the rays of ``self``.
INPUT:
- ``ray_list`` -- list of integers, the indices of the requested rays.
If not specified, an iterator over all rays of ``self`` will be
returned.
OUTPUT:
- iterator.
EXAMPLES::
sage: c = Cone([(1,0), (0,1), (-1, 0)])
sage: [ray for ray in c.ray_iterator()]
doctest:...: DeprecationWarning:
ray_iterator(...) is deprecated!
See http://trac.sagemath.org/12544 for details.
[N(0, 1), N(1, 0), N(-1, 0)]
"""
deprecation(12544, "ray_iterator(...) is deprecated!")
if ray_list is None:
for ray in self._rays:
yield ray
else:
rays = self._rays
for n in ray_list:
yield rays[n]
def ray_matrix(self):
r"""
Return a matrix whose columns are rays of ``self``.
It can be convenient for linear algebra operations on rays, as well as
for easy-to-read output.
OUTPUT:
- matrix.
EXAMPLES::
sage: c = Cone([(1,0), (0,1), (-1, 0)])
sage: c.ray_matrix()
doctest:...: DeprecationWarning:
ray_matrix(...) is deprecated,
please use rays().column_matrix() instead!
See http://trac.sagemath.org/12544 for details.
[ 0 1 -1]
[ 1 0 0]
"""
deprecation(12544, "ray_matrix(...) is deprecated, "
"please use rays().column_matrix() instead!")
return self.rays().column_matrix()
def ray_set(self):
r"""
Return rays of ``self`` as a :class:`frozenset`.
Use :meth:`rays` if you want to get rays in the fixed order.
OUTPUT:
- :class:`frozenset` of rays.
EXAMPLES::
sage: c = Cone([(1,0), (0,1), (-1, 0)])
sage: c.ray_set()
doctest:1: DeprecationWarning:
ray_set(...) is deprecated, please use rays().set() instead!
See http://trac.sagemath.org/12544 for details.
frozenset([N(0, 1), N(1, 0), N(-1, 0)])
"""
deprecation(12544, "ray_set(...) is deprecated, "
"please use rays().set() instead!")
return self.rays().set()
def rays(self, *args):
r"""
Return (some of the) rays of ``self``.
INPUT:
- ``ray_list`` -- a list of integers, the indices of the requested
rays. If not specified, all rays of ``self`` will be returned.
OUTPUT:
- a :class:`~sage.geometry.point_collection.PointCollection`
of primitive integral ray generators.
EXAMPLES::
sage: c = Cone([(1,0), (0,1), (-1, 0)])
sage: c.rays()
N( 0, 1),
N( 1, 0),
N(-1, 0)
in 2-d lattice N
sage: c.rays([0, 2])
N( 0, 1),
N(-1, 0)
in 2-d lattice N
You can also give ray indices directly, without packing them into a
list::
sage: c.rays(0, 2)
N( 0, 1),
N(-1, 0)
in 2-d lattice N
"""
return self._rays if not args else self._rays(*args)
def ray_basis(self):
r"""
Returns a linearly independent subset of the rays.
OUTPUT:
Returns a random but fixed choice of a `\QQ`-basis (of
N-lattice points) for the vector space spanned by the rays.
.. NOTE::
See :meth:`sage.geometry.cone.ConvexRationalPolyhedralCone.sublattice`
if you need a `\ZZ`-basis.
EXAMPLES::
sage: c = Cone([(1,1,1,1), (1,-1,1,1), (-1,-1,1,1), (-1,1,1,1), (0,0,0,1)])
sage: c.ray_basis()
doctest:...: DeprecationWarning:
ray_basis(...) is deprecated,
please use rays().basis() instead!
See http://trac.sagemath.org/12544 for details.
N( 1, 1, 1, 1),
N( 1, -1, 1, 1),
N(-1, -1, 1, 1),
N( 0, 0, 0, 1)
in 4-d lattice N
"""
deprecation(12544, "ray_basis(...) is deprecated, "
"please use rays().basis() instead!")
return self.rays().basis()
def ray_basis_matrix(self):
r"""
Returns a linearly independent subset of the rays as a matrix.
OUTPUT:
- Returns a random but fixed choice of a `\QQ`-basis (of
N-lattice points) for the vector space spanned by the rays.
- The linearly independent rays are the columns of the returned matrix.
.. NOTE::
* see also :meth:`ray_basis`.
* See :meth:`sage.geometry.cone.ConvexRationalPolyhedralCone.sublattice`
if you need a `\ZZ`-basis.
EXAMPLES::
sage: c = Cone([(1,1,1,1), (1,-1,1,1), (-1,-1,1,1), (-1,1,1,1), (0,0,0,1)])
sage: c.ray_basis_matrix()
doctest:...: DeprecationWarning:
ray_basis_matrix(...) is deprecated,
please use rays().basis().column_matrix() instead!
See http://trac.sagemath.org/12544 for details.
[ 1 1 -1 0]
[ 1 -1 -1 0]
[ 1 1 1 0]
[ 1 1 1 1]
"""
deprecation(12544, "ray_basis_matrix(...) is deprecated, "
"please use rays().basis().column_matrix() instead!")
return self.rays().basis().column_matrix()
def classify_cone_2d(ray0, ray1, check=True):
"""
Return `(d,k)` classifying the lattice cone spanned by the two rays.
INPUT:
- ``ray0``, ``ray1`` -- two primitive integer vectors. The
generators of the two rays generating the two-dimensional cone.
- ``check`` -- boolean (default: ``True``). Whether to check the
input rays for consistency.
OUTPUT:
A pair `(d,k)` of integers classifying the cone up to `GL(2, \ZZ)`
equivalence. See Proposition 10.1.1 of [CLS]_ for the
definition. We return the unique `(d,k)` with minmial `k`, see
Proposition 10.1.3 of [CLS]_.
EXAMPLES::
sage: ray0 = vector([1,0])
sage: ray1 = vector([2,3])
sage: from sage.geometry.cone import classify_cone_2d
sage: classify_cone_2d(ray0, ray1)
(3, 2)
sage: ray0 = vector([2,4,5])
sage: ray1 = vector([5,19,11])
sage: classify_cone_2d(ray0, ray1)
(3, 1)
sage: m = matrix(ZZ, [(19, -14, -115), (-2, 5, 25), (43, -42, -298)])
sage: m.det() # check that it is in GL(3,ZZ)
-1
sage: classify_cone_2d(m*ray0, m*ray1)
(3, 1)
TESTS:
Check using the connection between the Hilbert basis of the cone
spanned by the two rays (in arbitrary dimension) and the
Hirzebruch-Jung continued fraction expansion, see Chapter 10 of
[CLS]_ ::
sage: from sage.geometry.cone import normalize_rays
sage: for i in range(10):
... ray0 = random_vector(ZZ, 3)
... ray1 = random_vector(ZZ, 3)
... if ray0.is_zero() or ray1.is_zero(): continue
... ray0, ray1 = normalize_rays([ray0, ray1], ZZ^3)
... d, k = classify_cone_2d(ray0, ray1, check=True)
... assert (d,k) == classify_cone_2d(ray1, ray0)
... if d == 0: continue
... frac = Hirzebruch_Jung_continued_fraction_list(k/d)
... if len(frac)>100: continue # avoid expensive computation
... hilb = Cone([ray0, ray1]).Hilbert_basis()
... assert len(hilb) == len(frac) + 1
"""
if check:
assert ray0.parent() is ray1.parent()
assert ray0.base_ring() is ZZ
assert gcd(ray0) == 1
assert gcd(ray1) == 1
assert not ray0.is_zero() and not ray1.is_zero()
m = matrix([ray0, ray1])
basis = m.saturation().solve_left(m)
basis = basis.change_ring(ZZ).transpose()
if basis.nrows() < 2:
d = 0
k = basis[0,1]
else:
basis.echelonize()
d = basis[1,1]
k = basis[0,1]
if check:
if d == 0:
assert basis[0,0] == 1
assert k == -1 or k == +1
else:
assert basis[0,0] == 1 and basis[1,0] == 0
assert d > 0
assert 0 <= k < d
assert gcd(d,k) == 1
if d > 0:
for ktilde in range(k):
if (k*ktilde) % d == 1:
k = ktilde
break
return (d,k)
class ConvexRationalPolyhedralCone(IntegralRayCollection,
collections.Container):
r"""
Create a convex rational polyhedral cone.
.. WARNING::
This class does not perform any checks of correctness of input nor
does it convert input into the standard representation. Use
:func:`Cone` to construct cones.
Cones are immutable, but they cache most of the returned values.
INPUT:
The input can be either:
- ``rays`` -- list of immutable primitive vectors in ``lattice``;
- ``lattice`` -- :class:`ToricLattice
<sage.geometry.toric_lattice.ToricLatticeFactory>`, `\ZZ^n`, or any
other object that behaves like these. If ``None``, it will be determined
as :func:`parent` of the first ray. Of course, this cannot be done if
there are no rays, so in this case you must give an appropriate
``lattice`` directly.
or (these parameters must be given as keywords):
- ``ambient`` -- ambient structure of this cone, a bigger :class:`cone
<ConvexRationalPolyhedralCone>` or a :class:`fan
<sage.geometry.fan.RationalPolyhedralFan>`, this cone *must be a face
of* ``ambient``;
- ``ambient_ray_indices`` -- increasing list or tuple of integers, indices
of rays of ``ambient`` generating this cone.
In both cases, the following keyword parameter may be specified in addition:
- ``PPL`` -- either ``None`` (default) or a
:class:`~sage.libs.ppl.C_Polyhedron` representing the cone. This
serves only to cache the polyhedral data if you know it
already. The polyhedron will be set immutable.
OUTPUT:
- convex rational polyhedral cone.
.. NOTE::
Every cone has its ambient structure. If it was not specified, it is
this cone itself.
"""
def __init__(self, rays=None, lattice=None,
ambient=None, ambient_ray_indices=None, PPL=None):
r"""
See :class:`ConvexRationalPolyhedralCone` for documentation.
TESTS::
sage: from sage.geometry.cone import (
... ConvexRationalPolyhedralCone)
sage: v1 = vector([1,0])
sage: v2 = vector([0,1])
sage: v1.set_immutable()
sage: v2.set_immutable()
sage: ac = ConvexRationalPolyhedralCone([v1, v2], ZZ^2)
sage: ac = ConvexRationalPolyhedralCone([v1, v2], None)
sage: ac.lattice() # Determined automatically
Ambient free module of rank 2
over the principal ideal domain Integer Ring
sage: ac.rays()
(1, 0),
(0, 1)
in Ambient free module of rank 2
over the principal ideal domain Integer Ring
sage: ac.ambient() is ac
True
sage: TestSuite(ac).run()
sage: sc = ConvexRationalPolyhedralCone(ambient=ac,
... ambient_ray_indices=[1])
sage: sc.rays()
(0, 1)
in Ambient free module of rank 2
over the principal ideal domain Integer Ring
sage: sc.ambient() is ac
True
sage: TestSuite(sc).run()
"""
superinit = super(ConvexRationalPolyhedralCone, self).__init__
if ambient is None:
superinit(rays, lattice)
self._ambient = self
self._ambient_ray_indices = tuple(range(self.nrays()))
else:
self._ambient = ambient
self._ambient_ray_indices = tuple(ambient_ray_indices)
superinit(ambient.rays(self._ambient_ray_indices),
ambient.lattice())
if not PPL is None:
self._PPL_C_Polyhedron = PPL
self._PPL_C_Polyhedron.set_immutable()
def _sage_input_(self, sib, coerced):
"""
Return Sage command to reconstruct ``self``.
See :mod:`sage.misc.sage_input` for details.
EXAMPLES::
sage: cone = Cone([(1,0), (1,1)])
sage: sage_input(cone)
Cone([(1, 0), (1, 1)])
"""
return sib.name('Cone')([sib(tuple(r)) for r in self.rays()])
def _PPL_cone(self):
r"""
Returns the Parma Polyhedra Library (PPL) representation of the cone.
OUTPUT:
A :class:`~sage.libs.ppl.C_Polyhedron` representing the cone.
EXAMPLES::
sage: c = Cone([(1,0), (1,1), (0,1)])
sage: c._PPL_cone()
A 2-dimensional polyhedron in QQ^2 defined as
the convex hull of 1 point, 2 rays
sage: c._PPL_cone().minimized_generators()
Generator_System {point(0/1, 0/1), ray(0, 1), ray(1, 0)}
sage: c._PPL_cone().minimized_constraints()
Constraint_System {x1>=0, x0>=0}
TESTS:
There are no empty cones, the origin always belongs to them::
sage: Cone([(0,0)])._PPL_cone()
A 0-dimensional polyhedron in QQ^2
defined as the convex hull of 1 point
sage: Cone([], lattice=ToricLattice(2))._PPL_cone()
A 0-dimensional polyhedron in QQ^2
defined as the convex hull of 1 point
"""
if "_PPL_C_Polyhedron" not in self.__dict__:
gs = Generator_System(
PPL_point(Linear_Expression(self._lattice(0), 0)))
for r in self.rays():
gs.insert( PPL_ray(Linear_Expression(r,0)) )
self._PPL_C_Polyhedron = C_Polyhedron(gs)
self._PPL_C_Polyhedron.set_immutable()
return self._PPL_C_Polyhedron
def __contains__(self, point):
r"""
Check if ``point`` is contained in ``self``.
See :meth:`_contains` (which is called by this function) for
documentation.
TESTS::
sage: c = Cone([(1,0), (0,1)])
sage: (1,1) in c
True
sage: [1,1] in c
True
sage: (-1,0) in c
False
"""
return self._contains(point)
def __getstate__(self):
r"""
Return the dictionary that should be pickled.
OUTPUT:
- :class:`dict`.
TESTS::
sage: C = Cone([(1,0)])
sage: C.face_lattice()
Finite poset containing 2 elements
sage: C._test_pickling()
sage: C2 = loads(dumps(C)); C2
1-d cone in 2-d lattice N
sage: C2 == C
True
sage: C2 is C # Is this desirable?
False
"""
state = copy.copy(self.__dict__)
state.pop("_polyhedron", None)
state.pop("_lattice_polytope", None)
state.pop("_PPL_C_Polyhedron", None)
state.pop("_face_lattice", None)
return state
def _contains(self, point, region='whole cone'):
r"""
Check if ``point`` is contained in ``self``.
This function is called by :meth:`__contains__` and :meth:`contains`
to ensure the same call depth for warning messages.
INPUT:
- ``point`` -- anything. An attempt will be made to convert it into a
single element of the ambient space of ``self``. If it fails,
``False`` is returned;
- ``region`` -- string. Can be either 'whole cone' (default),
'interior', or 'relative interior'. By default, a point on
the boundary of the cone is considered part of the cone. If
you want to test whether the **interior** of the cone
contains the point, you need to pass the optional argument
``'interior'``. If you want to test whether the **relative
interior** of the cone contains the point, you need to pass
the optional argument ``'relative_interior'``.
OUTPUT:
- ``True`` if ``point`` is contained in the specified ``region`` of
``self``, ``False`` otherwise.
Raises a ``ValueError`` if ``region`` is not one of the
three allowed values.
TESTS::
sage: c = Cone([(1,0), (0,1)])
sage: c._contains((1,1))
True
"""
try:
point = self._ambient_space_point(point)
except TypeError, ex:
if str(ex).endswith("have incompatible lattices!"):
warnings.warn("you have checked if a cone contains a point "
"from an incompatible lattice, this is False!",
stacklevel=3)
return False
if region not in ("whole cone", "relative interior", "interior"):
raise ValueError("%s is an unknown region of the cone!" % region)
if region == "interior" and self.dim() < self.lattice_dim():
return False
need_strict = region.endswith("interior")
M = self.dual_lattice()
for c in self._PPL_cone().minimized_constraints():
pr = M(c.coefficients()) * point
if c.is_equality():
if pr != 0:
return False
elif pr < 0 or need_strict and pr == 0:
return False
return True
def interior_contains(self, *args):
r"""
Check if a given point is contained in the interior of ``self``.
For a cone of strictly lower-dimension than the ambient space,
the interior is always empty. You probably want to use
:meth:`relative_interior_contains` in this case.
INPUT:
- anything. An attempt will be made to convert all arguments into a
single element of the ambient space of ``self``. If it fails,
``False`` will be returned.
OUTPUT:
- ``True`` if the given point is contained in the interior of
``self``, ``False`` otherwise.
EXAMPLES::
sage: c = Cone([(1,0), (0,1)])
sage: c.contains((1,1))
True
sage: c.interior_contains((1,1))
True
sage: c.contains((1,0))
True
sage: c.interior_contains((1,0))
False
"""
point = flatten(args)
if len(point) == 1:
point = point[0]
return self._contains(point, 'interior')
def relative_interior_contains(self, *args):
r"""
Check if a given point is contained in the relative interior of ``self``.
For a full-dimensional cone the relative interior is simply
the interior, so this method will do the same check as
:meth:`interior_contains`. For a strictly lower-dimensional cone, the
relative interior is the cone without its facets.
INPUT:
- anything. An attempt will be made to convert all arguments into a
single element of the ambient space of ``self``. If it fails,
``False`` will be returned.
OUTPUT:
- ``True`` if the given point is contained in the relative
interior of ``self``, ``False`` otherwise.
EXAMPLES::
sage: c = Cone([(1,0,0), (0,1,0)])
sage: c.contains((1,1,0))
True
sage: c.relative_interior_contains((1,1,0))
True
sage: c.interior_contains((1,1,0))
False
sage: c.contains((1,0,0))
True
sage: c.relative_interior_contains((1,0,0))
False
sage: c.interior_contains((1,0,0))
False
"""
point = flatten(args)
if len(point) == 1:
point = point[0]
return self._contains(point, 'relative interior')
def cartesian_product(self, other, lattice=None):
r"""
Return the Cartesian product of ``self`` with ``other``.
INPUT:
- ``other`` -- a :class:`cone <ConvexRationalPolyhedralCone>`;
- ``lattice`` -- (optional) the ambient lattice for the
Cartesian product cone. By default, the direct sum of the
ambient lattices of ``self`` and ``other`` is constructed.
OUTPUT:
- a :class:`cone <ConvexRationalPolyhedralCone>`.
EXAMPLES::
sage: c = Cone([(1,)])
sage: c.cartesian_product(c)
2-d cone in 2-d lattice N+N
sage: _.rays()
N+N(1, 0),
N+N(0, 1)
in 2-d lattice N+N
"""
assert is_Cone(other)
rc = super(ConvexRationalPolyhedralCone, self).cartesian_product(
other, lattice)
return ConvexRationalPolyhedralCone(rc.rays(), rc.lattice())
def __cmp__(self, right):
r"""
Compare ``self`` and ``right``.
INPUT:
- ``right`` -- anything.
OUTPUT:
- 0 if ``self`` and ``right`` are cones of any kind in the same
lattice with the same rays listed in the same order. 1 or -1
otherwise.
TESTS::
sage: c1 = Cone([(1,0), (0,1)])
sage: c2 = Cone([(0,1), (1,0)])
sage: c3 = Cone([(0,1), (1,0)])
sage: cmp(c1, c2)
1
sage: cmp(c2, c1)
-1
sage: cmp(c2, c3)
0
sage: c2 is c3
False
sage: cmp(c1, 1) * cmp(1, c1)
-1
"""
if is_Cone(right):
return cmp((self.lattice(), self.rays()),
(right.lattice(), right.rays()))
else:
return cmp(type(self), type(right))
def _latex_(self):
r"""
Return a LaTeX representation of ``self``.
OUTPUT:
- string.
TESTS::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant._latex_()
'\\sigma^{2}'
sage: quadrant.facets()[0]._latex_()
'\\sigma^{1} \\subset \\sigma^{2}'
"""
if self.ambient() is self:
return r"\sigma^{%d}" % self.dim()
else:
return r"\sigma^{%d} \subset %s" % (self.dim(),
latex(self.ambient()))
def _repr_(self):
r"""
Return a string representation of ``self``.
OUTPUT:
- string.
TESTS::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant._repr_()
'2-d cone in 2-d lattice N'
sage: quadrant
2-d cone in 2-d lattice N
sage: quadrant.facets()[0]
1-d face of 2-d cone in 2-d lattice N
"""
result = "%d-d" % self.dim()
if self.ambient() is self:
result += " cone in"
if is_ToricLattice(self.lattice()):
result += " %s" % self.lattice()
else:
result += " %d-d lattice" % self.lattice_dim()
else:
result += " face of %s" % self.ambient()
return result
def _sort_faces(self, faces):
r"""
Return sorted (if necessary) ``faces`` as a tuple.
This function ensures that one-dimensional faces are listed in
agreement with the order of corresponding rays.
INPUT:
- ``faces`` -- iterable of :class:`cones
<ConvexRationalPolyhedralCone>`.
OUTPUT:
- :class:`tuple` of :class:`cones <ConvexRationalPolyhedralCone>`.
TESTS::
sage: octant = Cone(identity_matrix(3).columns())
sage: # indirect doctest
sage: for i, face in enumerate(octant.faces(1)):
... if face.ray(0) != octant.ray(i):
... print "Wrong order!"
"""
faces = tuple(faces)
if len(faces) > 1:
if faces[0].nrays() == 1:
faces = tuple(sorted(faces,
key=lambda f: f._ambient_ray_indices))
return faces
@cached_method
def adjacent(self):
r"""
Return faces adjacent to ``self`` in the ambient face lattice.
Two *distinct* faces `F_1` and `F_2` of the same face lattice are
**adjacent** if all of the following conditions hold:
* `F_1` and `F_2` have the same dimension `d`;
* `F_1` and `F_2` share a facet of dimension `d-1`;
* `F_1` and `F_2` are facets of some face of dimension `d+1`, unless
`d` is the dimension of the ambient structure.
OUTPUT:
- :class:`tuple` of :class:`cones <ConvexRationalPolyhedralCone>`.
EXAMPLES::
sage: octant = Cone([(1,0,0), (0,1,0), (0,0,1)])
sage: octant.adjacent()
()
sage: one_face = octant.faces(1)[0]
sage: len(one_face.adjacent())
2
sage: one_face.adjacent()[1]
1-d face of 3-d cone in 3-d lattice N
Things are a little bit subtle with fans, as we illustrate below.
First, we create a fan from two cones in the plane::
sage: fan = Fan(cones=[(0,1), (1,2)],
... rays=[(1,0), (0,1), (-1,0)])
sage: cone = fan.generating_cone(0)
sage: len(cone.adjacent())
1
The second generating cone is adjacent to this one. Now we create the
same fan, but embedded into the 3-dimensional space::
sage: fan = Fan(cones=[(0,1), (1,2)],
... rays=[(1,0,0), (0,1,0), (-1,0,0)])
sage: cone = fan.generating_cone(0)
sage: len(cone.adjacent())
1
The result is as before, since we still have::
sage: fan.dim()
2
Now we add another cone to make the fan 3-dimensional::
sage: fan = Fan(cones=[(0,1), (1,2), (3,)],
... rays=[(1,0,0), (0,1,0), (-1,0,0), (0,0,1)])
sage: cone = fan.generating_cone(0)
sage: len(cone.adjacent())
0
Since now ``cone`` has smaller dimension than ``fan``, it and its
adjacent cones must be facets of a bigger one, but since ``cone``
in this example is generating, it is not contained in any other.
"""
L = self._ambient._face_lattice_function()
adjacent = set()
facets = self.facets()
superfaces = self.facet_of()
if superfaces:
for superface in superfaces:
for facet in facets:
adjacent.update(L.open_interval(facet, superface))
if adjacent:
adjacent.remove(L(self))
return self._sort_faces(adjacent)
elif self.dim() == self._ambient.dim():
for facet in facets:
adjacent.update(facet.facet_of())
if adjacent:
adjacent.remove(self)
return self._sort_faces(adjacent)
else:
return ()
def ambient(self):
r"""
Return the ambient structure of ``self``.
OUTPUT:
- cone or fan containing ``self`` as a face.
EXAMPLES::
sage: cone = Cone([(1,2,3), (4,6,5), (9,8,7)])
sage: cone.ambient()
3-d cone in 3-d lattice N
sage: cone.ambient() is cone
True
sage: face = cone.faces(1)[0]
sage: face
1-d face of 3-d cone in 3-d lattice N
sage: face.ambient()
3-d cone in 3-d lattice N
sage: face.ambient() is cone
True
"""
return self._ambient
def ambient_ray_indices(self):
r"""
Return indices of rays of the ambient structure generating ``self``.
OUTPUT:
- increasing :class:`tuple` of integers.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant.ambient_ray_indices()
(0, 1)
sage: quadrant.facets()[1].ambient_ray_indices()
(1,)
"""
return self._ambient_ray_indices
def contains(self, *args):
r"""
Check if a given point is contained in ``self``.
INPUT:
- anything. An attempt will be made to convert all arguments into a
single element of the ambient space of ``self``. If it fails,
``False`` will be returned.
OUTPUT:
- ``True`` if the given point is contained in ``self``, ``False``
otherwise.
EXAMPLES::
sage: c = Cone([(1,0), (0,1)])
sage: c.contains(c.lattice()(1,0))
True
sage: c.contains((1,0))
True
sage: c.contains((1,1))
True
sage: c.contains(1,1)
True
sage: c.contains((-1,0))
False
sage: c.contains(c.dual_lattice()(1,0)) #random output (warning)
False
sage: c.contains(c.dual_lattice()(1,0))
False
sage: c.contains(1)
False
sage: c.contains(1/2, sqrt(3))
True
sage: c.contains(-1/2, sqrt(3))
False
"""
point = flatten(args)
if len(point) == 1:
point = point[0]
return self._contains(point)
def dual(self):
r"""
Return the dual cone of ``self``.
OUTPUT:
- :class:`cone <ConvexRationalPolyhedralCone>`.
EXAMPLES::
sage: cone = Cone([(1,0), (-1,3)])
sage: cone.dual().rays()
M(3, 1),
M(0, 1)
in 2-d lattice M
Now let's look at a more complicated case::
sage: cone = Cone([(-2,-1,2), (4,1,0), (-4,-1,-5), (4,1,5)])
sage: cone.is_strictly_convex()
False
sage: cone.dim()
3
sage: cone.dual().rays()
M(7, -18, -2),
M(1, -4, 0)
in 3-d lattice M
sage: cone.dual().dual() is cone
True
We correctly handle the degenerate cases::
sage: N = ToricLattice(2)
sage: Cone([], lattice=N).dual().rays() # empty cone
M( 1, 0),
M(-1, 0),
M( 0, 1),
M( 0, -1)
in 2-d lattice M
sage: Cone([(1,0)], lattice=N).dual().rays() # ray in 2d
M(1, 0),
M(0, 1),
M(0, -1)
in 2-d lattice M
sage: Cone([(1,0),(-1,0)], lattice=N).dual().rays() # line in 2d
M(0, 1),
M(0, -1)
in 2-d lattice M
sage: Cone([(1,0),(0,1)], lattice=N).dual().rays() # strictly convex cone
M(1, 0),
M(0, 1)
in 2-d lattice M
sage: Cone([(1,0),(-1,0),(0,1)], lattice=N).dual().rays() # half space
M(0, 1)
in 2-d lattice M
sage: Cone([(1,0),(0,1),(-1,-1)], lattice=N).dual().rays() # whole space
Empty collection
in 2-d lattice M
"""
if "_dual" not in self.__dict__:
rays = list(self.facet_normals())
for ray in self.orthogonal_sublattice().gens():
rays.append(ray)
rays.append(-ray)
self._dual = Cone(rays, lattice=self.dual_lattice(), check=False)
self._dual._dual = self
return self._dual
def embed(self, cone):
r"""
Return the cone equivalent to the given one, but sitting in ``self`` as
a face.
You may need to use this method before calling methods of ``cone`` that
depend on the ambient structure, such as
:meth:`~sage.geometry.cone.ConvexRationalPolyhedralCone.ambient_ray_indices`
or
:meth:`~sage.geometry.cone.ConvexRationalPolyhedralCone.facet_of`. The
cone returned by this method will have ``self`` as ambient. If ``cone``
does not represent a valid cone of ``self``, ``ValueError`` exception
is raised.
.. NOTE::
This method is very quick if ``self`` is already the ambient
structure of ``cone``, so you can use without extra checks and
performance hit even if ``cone`` is likely to sit in ``self`` but
in principle may not.
INPUT:
- ``cone`` -- a :class:`cone
<sage.geometry.cone.ConvexRationalPolyhedralCone>`.
OUTPUT:
- a :class:`cone <sage.geometry.cone.ConvexRationalPolyhedralCone>`,
equivalent to ``cone`` but sitting inside ``self``.
EXAMPLES:
Let's take a 3-d cone on 4 rays::
sage: c = Cone([(1,0,1), (0,1,1), (-1,0,1), (0,-1,1)])
Then any ray generates a 1-d face of this cone, but if you construct
such a face directly, it will not "sit" inside the cone::
sage: ray = Cone([(0,-1,1)])
sage: ray
1-d cone in 3-d lattice N
sage: ray.ambient_ray_indices()
(0,)
sage: ray.adjacent()
()
sage: ray.ambient()
1-d cone in 3-d lattice N
If we want to operate with this ray as a face of the cone, we need to
embed it first::
sage: e_ray = c.embed(ray)
sage: e_ray
1-d face of 3-d cone in 3-d lattice N
sage: e_ray.rays()
N(0, -1, 1)
in 3-d lattice N
sage: e_ray is ray
False
sage: e_ray.is_equivalent(ray)
True
sage: e_ray.ambient_ray_indices()
(3,)
sage: e_ray.adjacent()
(1-d face of 3-d cone in 3-d lattice N,
1-d face of 3-d cone in 3-d lattice N)
sage: e_ray.ambient()
3-d cone in 3-d lattice N
Not every cone can be embedded into a fixed ambient cone::
sage: c.embed(Cone([(0,0,1)]))
Traceback (most recent call last):
...
ValueError: 1-d cone in 3-d lattice N is not a face
of 3-d cone in 3-d lattice N!
sage: c.embed(Cone([(1,0,1), (-1,0,1)]))
Traceback (most recent call last):
...
ValueError: 2-d cone in 3-d lattice N is not a face
of 3-d cone in 3-d lattice N!
"""
assert is_Cone(cone)
if cone.ambient() is self:
return cone
if self.is_strictly_convex():
rays = self.rays()
try:
ray_indices = tuple(sorted(rays.index(ray)
for ray in cone.rays()))
for face in self.faces(cone.dim()):
if face.ambient_ray_indices() == ray_indices:
return face
except ValueError:
pass
else:
for face in self.faces(cone.dim()):
if cone.is_equivalent(face):
return face
raise ValueError("%s is not a face of %s!" % (cone, self))
def face_lattice(self):
r"""
Return the face lattice of ``self``.
This lattice will have the origin as the bottom (we do not include the
empty set as a face) and this cone itself as the top.
OUTPUT:
- :class:`finite poset <sage.combinat.posets.posets.FinitePoset>` of
:class:`cones <ConvexRationalPolyhedralCone>`.
EXAMPLES:
Let's take a look at the face lattice of the first quadrant::
sage: quadrant = Cone([(1,0), (0,1)])
sage: L = quadrant.face_lattice()
sage: L
Finite poset containing 4 elements
To see all faces arranged by dimension, you can do this::
sage: for level in L.level_sets(): print level
[0-d face of 2-d cone in 2-d lattice N]
[1-d face of 2-d cone in 2-d lattice N,
1-d face of 2-d cone in 2-d lattice N]
[2-d cone in 2-d lattice N]
For a particular face you can look at its actual rays... ::
sage: face = L.level_sets()[1][0]
sage: face.rays()
N(1, 0)
in 2-d lattice N
... or you can see the index of the ray of the original cone that
corresponds to the above one::
sage: face.ambient_ray_indices()
(0,)
sage: quadrant.ray(0)
N(1, 0)
An alternative to extracting faces from the face lattice is to use
:meth:`faces` method::
sage: face is quadrant.faces(dim=1)[0]
True
The advantage of working with the face lattice directly is that you
can (relatively easily) get faces that are related to the given one::
sage: face = L.level_sets()[1][0]
sage: D = L.hasse_diagram()
sage: D.neighbors(face)
[2-d cone in 2-d lattice N,
0-d face of 2-d cone in 2-d lattice N]
However, you can achieve some of this functionality using
:meth:`facets`, :meth:`facet_of`, and :meth:`adjacent` methods::
sage: face = quadrant.faces(1)[0]
sage: face
1-d face of 2-d cone in 2-d lattice N
sage: face.rays()
N(1, 0)
in 2-d lattice N
sage: face.facets()
(0-d face of 2-d cone in 2-d lattice N,)
sage: face.facet_of()
(2-d cone in 2-d lattice N,)
sage: face.adjacent()
(1-d face of 2-d cone in 2-d lattice N,)
sage: face.adjacent()[0].rays()
N(0, 1)
in 2-d lattice N
Note that if ``cone`` is a face of ``supercone``, then the face
lattice of ``cone`` consists of (appropriate) faces of ``supercone``::
sage: supercone = Cone([(1,2,3,4), (5,6,7,8),
... (1,2,4,8), (1,3,9,7)])
sage: supercone.face_lattice()
Finite poset containing 16 elements
sage: supercone.face_lattice().top()
4-d cone in 4-d lattice N
sage: cone = supercone.facets()[0]
sage: cone
3-d face of 4-d cone in 4-d lattice N
sage: cone.face_lattice()
Finite poset containing 8 elements
sage: cone.face_lattice().bottom()
0-d face of 4-d cone in 4-d lattice N
sage: cone.face_lattice().top()
3-d face of 4-d cone in 4-d lattice N
sage: cone.face_lattice().top() == cone
True
TESTS::
sage: C1 = Cone([(0,1)])
sage: C2 = Cone([(0,1)])
sage: C1 == C2
True
sage: C1 is C2
False
C1 and C2 are equal, but not identical. We currently want them
to have non identical face lattices, even if the faces
themselves are equal (see #10998)::
sage: C1.face_lattice() is C2.face_lattice()
False
sage: C1.facets()[0]
0-d face of 1-d cone in 2-d lattice N
sage: C2.facets()[0]
0-d face of 1-d cone in 2-d lattice N
sage: C1.facets()[0].ambient() is C1
True
sage: C2.facets()[0].ambient() is C1
False
sage: C2.facets()[0].ambient() is C2
True
"""
if "_face_lattice" not in self.__dict__:
if self._ambient is self:
S = self.linear_subspace()
subspace_rays = []
atom_to_ray = []
atom_to_facets = []
normals = self.facet_normals()
facet_to_atoms = [[] for normal in normals]
for i, ray in enumerate(self):
if ray in S:
subspace_rays.append(i)
else:
facets = [j for j, normal in enumerate(normals)
if ray * normal == 0]
atom_to_facets.append(facets)
atom = len(atom_to_ray)
for j in facets:
facet_to_atoms[j].append(atom)
atom_to_ray.append(i)
def ConeFace(atoms, facets):
if facets:
rays = sorted([atom_to_ray[a] for a in atoms]
+ subspace_rays)
face = ConvexRationalPolyhedralCone(
ambient=self, ambient_ray_indices=rays)
face._containing_cone_facets = facets
return face
else:
return self
self._face_lattice = Hasse_diagram_from_incidences(
atom_to_facets, facet_to_atoms, ConeFace,
key = id(self))
else:
allowed_indices = frozenset(self._ambient_ray_indices)
L = DiGraph()
origin = \
self._ambient._face_lattice_function().bottom()
L.add_vertex(0)
dfaces = [origin]
faces = [origin]
face_to_index = {origin:0}
next_index = 1
next_d = 1
while next_d < self.dim():
ndfaces = []
for face in dfaces:
face_index = face_to_index[face]
for new_face in face.facet_of():
if not allowed_indices.issuperset(
new_face._ambient_ray_indices):
continue
if new_face in ndfaces:
new_face_index = face_to_index[new_face]
else:
ndfaces.append(new_face)
face_to_index[new_face] = next_index
new_face_index = next_index
next_index += 1
L.add_edge(face_index, new_face_index)
faces.extend(ndfaces)
dfaces = ndfaces
next_d += 1
if self.dim() > 0:
faces.append(self)
for face in dfaces:
L.add_edge(face_to_index[face], next_index)
self._face_lattice = FinitePoset(L, faces, key = id(self))
return self._face_lattice
_face_lattice_function = face_lattice
def faces(self, dim=None, codim=None):
r"""
Return faces of ``self`` of specified (co)dimension.
INPUT:
- ``dim`` -- integer, dimension of the requested faces;
- ``codim`` -- integer, codimension of the requested faces.
.. NOTE::
You can specify at most one parameter. If you don't give any, then
all faces will be returned.
OUTPUT:
- if either ``dim`` or ``codim`` is given, the output will be a
:class:`tuple` of :class:`cones <ConvexRationalPolyhedralCone>`;
- if neither ``dim`` nor ``codim`` is given, the output will be the
:class:`tuple` of tuples as above, giving faces of all existing
dimensions. If you care about inclusion relations between faces,
consider using :meth:`face_lattice` or :meth:`adjacent`,
:meth:`facet_of`, and :meth:`facets`.
EXAMPLES:
Let's take a look at the faces of the first quadrant::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant.faces()
((0-d face of 2-d cone in 2-d lattice N,),
(1-d face of 2-d cone in 2-d lattice N,
1-d face of 2-d cone in 2-d lattice N),
(2-d cone in 2-d lattice N,))
sage: quadrant.faces(dim=1)
(1-d face of 2-d cone in 2-d lattice N,
1-d face of 2-d cone in 2-d lattice N)
sage: face = quadrant.faces(dim=1)[0]
Now you can look at the actual rays of this face... ::
sage: face.rays()
N(1, 0)
in 2-d lattice N
... or you can see indices of the rays of the orginal cone that
correspond to the above ray::
sage: face.ambient_ray_indices()
(0,)
sage: quadrant.ray(0)
N(1, 0)
Note that it is OK to ask for faces of too small or high dimension::
sage: quadrant.faces(-1)
()
sage: quadrant.faces(3)
()
In the case of non-strictly convex cones even faces of small
non-negative dimension may be missing::
sage: halfplane = Cone([(1,0), (0,1), (-1,0)])
sage: halfplane.faces(0)
()
sage: halfplane.faces()
((1-d face of 2-d cone in 2-d lattice N,),
(2-d cone in 2-d lattice N,))
sage: plane = Cone([(1,0), (0,1), (-1,-1)])
sage: plane.faces(1)
()
sage: plane.faces()
((2-d cone in 2-d lattice N,),)
TESTS:
Now we check that "general" cones whose dimension is smaller than the
dimension of the ambient space work as expected (see Trac #9188)::
sage: c = Cone([(1,1,1,3),(1,-1,1,3),(-1,-1,1,3)])
sage: c.faces()
((0-d face of 3-d cone in 4-d lattice N,),
(1-d face of 3-d cone in 4-d lattice N,
1-d face of 3-d cone in 4-d lattice N,
1-d face of 3-d cone in 4-d lattice N),
(2-d face of 3-d cone in 4-d lattice N,
2-d face of 3-d cone in 4-d lattice N,
2-d face of 3-d cone in 4-d lattice N),
(3-d cone in 4-d lattice N,))
We also ensure that a call to this function does not break
:meth:`facets` method (see :trac:`9780`)::
sage: cone = toric_varieties.dP8().fan().generating_cone(0)
sage: cone
2-d cone of Rational polyhedral fan in 2-d lattice N
sage: for f in cone.facets(): print f.rays()
N(1, 1)
in 2-d lattice N
N(0, 1)
in 2-d lattice N
sage: len(cone.faces())
3
sage: for f in cone.facets(): print f.rays()
N(1, 1)
in 2-d lattice N
N(0, 1)
in 2-d lattice N
"""
if dim is not None and codim is not None:
raise ValueError(
"dimension and codimension cannot be specified together!")
dim = self.dim() - codim if codim is not None else dim
if "_faces" not in self.__dict__:
self._faces = tuple(map(self._sort_faces,
self.face_lattice().level_sets()))
if len(self._faces) > 1:
self._facets = self._faces[-2]
if dim is None:
return self._faces
else:
lsd = self.linear_subspace().dimension()
return self._faces[dim - lsd] if lsd <= dim <= self.dim() else ()
def facet_normals(self):
r"""
Return inward normals to facets of ``self``.
.. NOTE::
#. For a not full-dimensional cone facet normals will specify
hyperplanes whose intersections with the space spanned by
``self`` give facets of ``self``.
#. For a not strictly convex cone facet normals will be orthogonal
to the linear subspace of ``self``, i.e. they always will be
elements of the dual cone of ``self``.
#. The order of normals is random and may be different from the
one in :meth:`facets`.
OUTPUT:
- a :class:`~sage.geometry.point_collection.PointCollection`.
If the ambient :meth:`~IntegralRayCollection.lattice` of ``self`` is a
:class:`toric lattice
<sage.geometry.toric_lattice.ToricLatticeFactory>`, the facet nomals
will be elements of the dual lattice. If it is a general lattice (like
``ZZ^n``) that does not have a ``dual()`` method, the facet normals
will be returned as integral vectors.
EXAMPLES::
sage: cone = Cone([(1,0), (-1,3)])
sage: cone.facet_normals()
M(3, 1),
M(0, 1)
in 2-d lattice M
Now let's look at a more complicated case::
sage: cone = Cone([(-2,-1,2), (4,1,0), (-4,-1,-5), (4,1,5)])
sage: cone.is_strictly_convex()
False
sage: cone.dim()
3
sage: cone.linear_subspace().dimension()
1
sage: lsg = (QQ^3)(cone.linear_subspace().gen(0)); lsg
(1, 1/4, 5/4)
sage: cone.facet_normals()
M(7, -18, -2),
M(1, -4, 0)
in 3-d lattice M
sage: [lsg*normal for normal in cone.facet_normals()]
[0, 0]
A lattice that does not have a ``dual()`` method::
sage: Cone([(1,1),(0,1)], lattice=ZZ^2).facet_normals()
( 1, 0),
(-1, 1)
in Ambient free module of rank 2
over the principal ideal domain Integer Ring
We correctly handle the degenerate cases::
sage: N = ToricLattice(2)
sage: Cone([], lattice=N).facet_normals() # empty cone
Empty collection
in 2-d lattice M
sage: Cone([(1,0)], lattice=N).facet_normals() # ray in 2d
M(1, 0)
in 2-d lattice M
sage: Cone([(1,0),(-1,0)], lattice=N).facet_normals() # line in 2d
Empty collection
in 2-d lattice M
sage: Cone([(1,0),(0,1)], lattice=N).facet_normals() # strictly convex cone
M(1, 0),
M(0, 1)
in 2-d lattice M
sage: Cone([(1,0),(-1,0),(0,1)], lattice=N).facet_normals() # half space
M(0, 1)
in 2-d lattice M
sage: Cone([(1,0),(0,1),(-1,-1)], lattice=N).facet_normals() # whole space
Empty collection
in 2-d lattice M
"""
if "_facet_normals" not in self.__dict__:
cone = self._PPL_cone()
normals = []
for c in cone.minimized_constraints():
assert c.inhomogeneous_term() == 0
if c.is_inequality():
normals.append(c.coefficients())
M = self.dual_lattice()
normals = tuple(map(M, normals))
for n in normals:
n.set_immutable()
self._facet_normals = PointCollection(normals, M)
return self._facet_normals
def facet_of(self):
r"""
Return *cones* of the ambient face lattice having ``self`` as a facet.
OUTPUT:
- :class:`tuple` of :class:`cones <ConvexRationalPolyhedralCone>`.
EXAMPLES::
sage: octant = Cone([(1,0,0), (0,1,0), (0,0,1)])
sage: octant.facet_of()
()
sage: one_face = octant.faces(1)[0]
sage: len(one_face.facet_of())
2
sage: one_face.facet_of()[1]
2-d face of 3-d cone in 3-d lattice N
While fan is the top element of its own cone lattice, which is a
variant of a face lattice, we do not refer to cones as its facets::
sage: fan = Fan([octant])
sage: fan.generating_cone(0).facet_of()
()
Subcones of generating cones work as before::
sage: one_cone = fan(1)[0]
sage: len(one_cone.facet_of())
2
"""
if "_facet_of" not in self.__dict__:
L = self._ambient._face_lattice_function()
H = L.hasse_diagram()
self._facet_of = self._sort_faces(f
for f in H.neighbors_out(L(self)) if is_Cone(f))
return self._facet_of
def facets(self):
r"""
Return facets (faces of codimension 1) of ``self``.
OUTPUT:
- :class:`tuple` of :class:`cones <ConvexRationalPolyhedralCone>`.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant.facets()
(1-d face of 2-d cone in 2-d lattice N,
1-d face of 2-d cone in 2-d lattice N)
"""
if "_facets" not in self.__dict__:
L = self._ambient._face_lattice_function()
H = L.hasse_diagram()
self._facets = self._sort_faces(H.neighbors_in(L(self)))
return self._facets
def intersection(self, other):
r"""
Compute the intersection of two cones.
INPUT:
- ``other`` - :class:`cone <ConvexRationalPolyhedralCone>`.
OUTPUT:
- :class:`cone <ConvexRationalPolyhedralCone>`.
Raises ``ValueError`` if the ambient space dimensions are not
compatible.
EXAMPLES::
sage: cone1 = Cone([(1,0), (-1, 3)])
sage: cone2 = Cone([(-1,0), (2, 5)])
sage: cone1.intersection(cone2).rays()
N(-1, 3),
N( 2, 5)
in 2-d lattice N
It is OK to intersect cones living in sublattices of the same ambient
lattice::
sage: N = cone1.lattice()
sage: Ns = N.submodule([(1,1)])
sage: cone3 = Cone([(1,1)], lattice=Ns)
sage: I = cone1.intersection(cone3)
sage: I.rays()
N(1, 1)
in Sublattice <N(1, 1)>
sage: I.lattice()
Sublattice <N(1, 1)>
But you cannot intersect cones from incompatible lattices without
explicit conversion::
sage: cone1.intersection(cone1.dual())
Traceback (most recent call last):
...
ValueError: 2-d lattice N and 2-d lattice M
have different ambient lattices!
sage: cone1.intersection(Cone(cone1.dual().rays(), N)).rays()
N(3, 1),
N(0, 1)
in 2-d lattice N
"""
if self._ambient is other._ambient:
ambient_ray_indices = tuple(r for r in self._ambient_ray_indices
if r in other._ambient_ray_indices)
return type(self)(ambient=self._ambient,
ambient_ray_indices=ambient_ray_indices)
p = C_Polyhedron(self._PPL_cone())
p.add_constraints(other._PPL_cone().constraints())
return _Cone_from_PPL(p, self.lattice().intersection(other.lattice()))
def is_equivalent(self, other):
r"""
Check if ``self`` is "mathematically" the same as ``other``.
INPUT:
- ``other`` - cone.
OUTPUT:
- ``True`` if ``self`` and ``other`` define the same cones as sets of
points in the same lattice, ``False`` otherwise.
There are three different equivalences between cones `C_1` and `C_2`
in the same lattice:
#. They have the same generating rays in the same order.
This is tested by ``C1 == C2``.
#. They describe the same sets of points.
This is tested by ``C1.is_equivalent(C2)``.
#. They are in the same orbit of `GL(n,\ZZ)` (and, therefore,
correspond to isomorphic affine toric varieties).
This is tested by ``C1.is_isomorphic(C2)``.
EXAMPLES::
sage: cone1 = Cone([(1,0), (-1, 3)])
sage: cone2 = Cone([(-1,3), (1, 0)])
sage: cone1.rays()
N( 1, 0),
N(-1, 3)
in 2-d lattice N
sage: cone2.rays()
N(-1, 3),
N( 1, 0)
in 2-d lattice N
sage: cone1 == cone2
False
sage: cone1.is_equivalent(cone2)
True
"""
if self is other:
return True
if self.ambient() is other.ambient() and self.is_strictly_convex():
return self.ambient_ray_indices() == other.ambient_ray_indices()
if self.lattice() != other.lattice():
return False
return self._PPL_cone() == other._PPL_cone()
def is_face_of(self, cone):
r"""
Check if ``self`` forms a face of another ``cone``.
INPUT:
- ``cone`` -- cone.
OUTPUT:
- ``True`` if ``self`` is a face of ``cone``, ``False`` otherwise.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: cone1 = Cone([(1,0)])
sage: cone2 = Cone([(1,2)])
sage: quadrant.is_face_of(quadrant)
True
sage: cone1.is_face_of(quadrant)
True
sage: cone2.is_face_of(quadrant)
False
Being a face means more than just saturating a facet
inequality::
sage: octant = Cone([(1,0,0), (0,1,0), (0,0,1)])
sage: cone = Cone([(2,1,0),(1,2,0)])
sage: cone.is_face_of(octant)
False
"""
if self.lattice() != cone.lattice():
return False
if self._ambient is cone._ambient:
return self.rays().set().issubset(cone.rays().set())
if self.is_equivalent(cone):
return True
if self.dim() >= cone.dim():
return False
saturates = Poly_Con_Relation.saturates()
supporting_hyperplanes = Constraint_System()
for c in cone._PPL_cone().minimized_constraints():
rel = self._PPL_cone().relation_with(c)
if c.is_equality() and not rel.implies(saturates):
return False
if c.is_inequality() and rel.implies(saturates):
c_eq = (Linear_Expression(c.coefficients(),
c.inhomogeneous_term()) == 0)
supporting_hyperplanes.insert(c_eq)
if supporting_hyperplanes.empty():
return False
cone_face = C_Polyhedron(cone._PPL_cone())
cone_face.add_constraints(supporting_hyperplanes)
return cone_face == self._PPL_cone()
def is_isomorphic(self, other):
r"""
Check if ``self`` is in the same `GL(n, \ZZ)`-orbit as ``other``.
INPUT:
- ``other`` - cone.
OUTPUT:
- ``True`` if ``self`` and ``other`` are in the same
`GL(n, \ZZ)`-orbit, ``False`` otherwise.
There are three different equivalences between cones `C_1` and `C_2`
in the same lattice:
#. They have the same generating rays in the same order.
This is tested by ``C1 == C2``.
#. They describe the same sets of points.
This is tested by ``C1.is_equivalent(C2)``.
#. They are in the same orbit of `GL(n,\ZZ)` (and, therefore,
correspond to isomorphic affine toric varieties).
This is tested by ``C1.is_isomorphic(C2)``.
EXAMPLES::
sage: cone1 = Cone([(1,0), (0, 3)])
sage: m = matrix(ZZ, [(1, -5), (-1, 4)]) # a GL(2,ZZ)-matrix
sage: cone2 = Cone([m*r for r in cone1.rays()])
sage: cone1.is_isomorphic(cone2)
True
sage: cone1 = Cone([(1,0), (0, 3)])
sage: cone2 = Cone([(-1,3), (1, 0)])
sage: cone1.is_isomorphic(cone2)
False
TESTS::
sage: from sage.geometry.cone import classify_cone_2d
sage: classify_cone_2d(*cone1.rays())
(1, 0)
sage: classify_cone_2d(*cone2.rays())
(3, 2)
"""
from sage.geometry.fan import Fan
return Fan([self]).is_isomorphic(Fan([other]))
def is_simplicial(self):
r"""
Check if ``self`` is simplicial.
A cone is called **simplicial** if primitive vectors along its
generating rays form a part of a *rational* basis of the ambient
space.
OUTPUT:
- ``True`` if ``self`` is simplicial, ``False`` otherwise.
EXAMPLES::
sage: cone1 = Cone([(1,0), (0, 3)])
sage: cone2 = Cone([(1,0), (0, 3), (-1,-1)])
sage: cone1.is_simplicial()
True
sage: cone2.is_simplicial()
False
"""
return self.nrays() == self.dim()
@cached_method
def is_smooth(self):
r"""
Check if ``self`` is smooth.
A cone is called **smooth** if primitive vectors along its
generating rays form a part of an *integral* basis of the
ambient space. Equivalently, they generate the whole lattice
on the linear subspace spanned by the rays.
OUTPUT:
- ``True`` if ``self`` is smooth, ``False`` otherwise.
EXAMPLES::
sage: cone1 = Cone([(1,0), (0, 1)])
sage: cone2 = Cone([(1,0), (-1, 3)])
sage: cone1.is_smooth()
True
sage: cone2.is_smooth()
False
The following cones are the same up to a `SL(2,\ZZ)`
coordinate transformation::
sage: Cone([(1,0,0), (2,1,-1)]).is_smooth()
True
sage: Cone([(1,0,0), (2,1,1)]).is_smooth()
True
sage: Cone([(1,0,0), (2,1,2)]).is_smooth()
True
"""
if not self.is_simplicial():
return False
return self.rays().matrix().elementary_divisors() == [1] * self.nrays()
def is_trivial(self):
"""
Checks if the cone has no rays.
OUTPUT:
- ``True`` if the cone has no rays, ``False`` otherwise.
EXAMPLES::
sage: c0 = Cone([], lattice=ToricLattice(3))
sage: c0.is_trivial()
True
sage: c0.nrays()
0
"""
return self.nrays() == 0
def is_strictly_convex(self):
r"""
Check if ``self`` is strictly convex.
A cone is called **strictly convex** if it does not contain any lines.
OUTPUT:
- ``True`` if ``self`` is strictly convex, ``False`` otherwise.
EXAMPLES::
sage: cone1 = Cone([(1,0), (0, 1)])
sage: cone2 = Cone([(1,0), (-1, 0)])
sage: cone1.is_strictly_convex()
True
sage: cone2.is_strictly_convex()
False
"""
if "_is_strictly_convex" not in self.__dict__:
convex = True
for gs in self._PPL_cone().minimized_generators():
if gs.is_line():
convex = False
break
self._is_strictly_convex = convex
return self._is_strictly_convex
def lattice_polytope(self):
r"""
Return the lattice polytope associated to ``self``.
The vertices of this polytope are primitive vectors along the
generating rays of ``self`` and the origin, if ``self`` is strictly
convex. In this case the origin is the last vertex, so the `i`-th ray
of the cone always corresponds to the `i`-th vertex of the polytope.
See also :meth:`polyhedron`.
OUTPUT:
- :class:`LatticePolytope
<sage.geometry.lattice_polytope.LatticePolytopeClass>`.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: lp = quadrant.lattice_polytope()
sage: lp
A lattice polytope: 2-dimensional, 3 vertices.
sage: lp.vertices()
[1 0 0]
[0 1 0]
sage: line = Cone([(1,0), (-1,0)])
sage: lp = line.lattice_polytope()
sage: lp
A lattice polytope: 1-dimensional, 2 vertices.
sage: lp.vertices()
[ 1 -1]
[ 0 0]
"""
if "_lattice_polytope" not in self.__dict__:
self._lattice_polytope = LatticePolytope(
tuple(self.rays()) + (self.lattice().zero(),),
compute_vertices=not self.is_strictly_convex())
return self._lattice_polytope
def line_set(self):
r"""
Return a set of lines generating the linear subspace of ``self``.
OUTPUT:
- :class:`frozenset` of primitive vectors in the lattice of ``self``
giving directions of lines that span the linear subspace of
``self``. These lines are arbitrary, but fixed. See also
:meth:`lines`.
EXAMPLES::
sage: halfplane = Cone([(1,0), (0,1), (-1,0)])
sage: halfplane.line_set()
doctest:1: DeprecationWarning:
line_set(...) is deprecated, please use lines().set() instead!
See http://trac.sagemath.org/12544 for details.
frozenset([N(1, 0)])
sage: fullplane = Cone([(1,0), (0,1), (-1,-1)])
sage: fullplane.line_set()
frozenset([N(0, 1), N(1, 0)])
"""
deprecation(12544, "line_set(...) is deprecated, "
"please use lines().set() instead!")
if "_line_set" not in self.__dict__:
self._line_set = frozenset(self.lines())
return self._line_set
@cached_method
def linear_subspace(self):
r"""
Return the largest linear subspace contained inside of ``self``.
OUTPUT:
- subspace of the ambient space of ``self``.
EXAMPLES::
sage: halfplane = Cone([(1,0), (0,1), (-1,0)])
sage: halfplane.linear_subspace()
Vector space of degree 2 and dimension 1 over Rational Field
Basis matrix:
[1 0]
"""
if self.is_strictly_convex():
return span([vector(QQ, self.lattice_dim())], QQ)
return span(self.lines(), QQ)
@cached_method
def lines(self):
r"""
Return lines generating the linear subspace of ``self``.
OUTPUT:
- :class:`tuple` of primitive vectors in the lattice of ``self``
giving directions of lines that span the linear subspace of
``self``. These lines are arbitrary, but fixed. If you do not care
about the order, see also :meth:`line_set`.
EXAMPLES::
sage: halfplane = Cone([(1,0), (0,1), (-1,0)])
sage: halfplane.lines()
N(1, 0)
in 2-d lattice N
sage: fullplane = Cone([(1,0), (0,1), (-1,-1)])
sage: fullplane.lines()
N(0, 1),
N(1, 0)
in 2-d lattice N
"""
lines = []
for g in self._PPL_cone().minimized_generators():
if g.is_line():
lines.append(g.coefficients())
N = self.lattice()
lines = tuple(map(N, lines))
for l in lines:
l.set_immutable()
return PointCollection(lines, N)
def plot(self, **options):
r"""
Plot ``self``.
INPUT:
- any options for toric plots (see :func:`toric_plotter.options
<sage.geometry.toric_plotter.options>`), none are mandatory.
OUTPUT:
- a plot.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant.plot()
"""
deg = self.lattice().degree()
tp = ToricPlotter(options, deg, self.rays())
tp.ray_label = label_list(tp.ray_label, self.nrays(), deg <= 2,
self.ambient_ray_indices())
result = tp.plot_lattice() + tp.plot_generators()
result += tp.plot_ray_labels()
tp.ray_label = None
lsd = self.linear_subspace().dimension()
if lsd == 1:
v = self.lines()[0]
tp.set_rays([v, -v])
if lsd <= 1:
result += tp.plot_rays()
walls = self.faces(2)
try:
ambient_walls = self.ambient().faces(2)
except AttributeError:
ambient_walls = self.ambient().cones(2)
tp.wall_label = label_list(tp.wall_label, len(walls), deg <= 2,
[ambient_walls.index(wall) for wall in walls])
tp.set_rays(self.ambient().rays())
result += tp.plot_walls(walls)
return result
def polyhedron(self):
r"""
Return the polyhedron associated to ``self``.
Mathematically this polyhedron is the same as ``self``.
See also :meth:`lattice_polytope`.
OUTPUT:
- :class:`~sage.geometry.polyhedron.base.Polyhedron_base`.
EXAMPLES::
sage: quadrant = Cone([(1,0), (0,1)])
sage: quadrant.polyhedron()
A 2-dimensional polyhedron in ZZ^2 defined as the convex hull
of 1 vertex and 2 rays
sage: line = Cone([(1,0), (-1,0)])
sage: line.polyhedron()
A 1-dimensional polyhedron in ZZ^2 defined as the convex hull
of 1 vertex and 1 line
Here is an example of a trivial cone (see Trac #10237)::
sage: origin = Cone([], lattice=ZZ^2)
sage: origin.polyhedron()
A 0-dimensional polyhedron in ZZ^2 defined as the convex hull
of 1 vertex
"""
if "_polyhedron" not in self.__dict__:
self._polyhedron = Polyhedron(rays=self.rays(),
vertices=[self.lattice()(0)])
return self._polyhedron
def strict_quotient(self):
r"""
Return the quotient of ``self`` by the linear subspace.
We define the **strict quotient** of a cone to be the image of this
cone in the quotient of the ambient space by the linear subspace of
the cone, i.e. it is the "complementary part" to the linear subspace.
OUTPUT:
- cone.
EXAMPLES::
sage: halfplane = Cone([(1,0), (0,1), (-1,0)])
sage: ssc = halfplane.strict_quotient()
sage: ssc
1-d cone in 1-d lattice N
sage: ssc.rays()
N(1)
in 1-d lattice N
sage: line = Cone([(1,0), (-1,0)])
sage: ssc = line.strict_quotient()
sage: ssc
0-d cone in 1-d lattice N
sage: ssc.rays()
Empty collection
in 1-d lattice N
"""
if "_strict_quotient" not in self.__dict__:
if self.is_strictly_convex():
self._strict_quotient = self
else:
L = self.lattice()
Q = L.base_extend(QQ) / self.linear_subspace()
if is_ToricLattice(L):
S = ToricLattice(Q.dimension(), L._name, L._dual_name,
L._latex_name, L._latex_dual_name)
else:
S = ZZ**Q.dimension()
rays = [Q(ray) for ray in self.rays() if not Q(ray).is_zero()]
quotient = Cone(rays, S, check=False)
quotient._is_strictly_convex = True
self._strict_quotient = quotient
return self._strict_quotient
def _split_ambient_lattice(self):
r"""
Compute a decomposition of the ``N``-lattice into `N_\sigma`
and its complement isomorphic to `N(\sigma)`.
You should not call this function directly, but call
:meth:`sublattice` and :meth:`sublattice_complement` instead.
EXAMPLES::
sage: c = Cone([ (1,2) ])
sage: c._split_ambient_lattice()
sage: c._sublattice
Sublattice <N(1, 2)>
sage: c._sublattice_complement
Sublattice <N(0, 1)>
Degenerate cases::
sage: C2_Z2 = Cone([(1,0),(1,2)])
sage: C2_Z2._split_ambient_lattice()
sage: C2_Z2._sublattice
Sublattice <N(1, 2), N(0, -1)>
Trivial cone::
sage: trivial_cone = Cone([], lattice=ToricLattice(3))
sage: trivial_cone._split_ambient_lattice()
sage: trivial_cone._sublattice
Sublattice <>
sage: trivial_cone._sublattice_complement
Sublattice <N(1, 0, 0), N(0, 1, 0), N(0, 0, 1)>
"""
N = self.lattice()
n = N.dimension()
basis = self.rays().basis()
r = len(basis)
Nsigma = matrix(ZZ, r, n, [N.coordinates(v) for v in basis])
D, U, V = Nsigma.smith_form()
basis = (V.inverse() * N.basis_matrix()).rows()
self._sublattice = N.submodule_with_basis(basis[:r])
self._sublattice_complement = N.submodule_with_basis(basis[r:])
def sublattice(self, *args, **kwds):
r"""
The sublattice spanned by the cone.
Let `\sigma` be the given cone and `N=` ``self.lattice()`` the
ambient lattice. Then, in the notation of [Fulton]_, this
method returns the sublattice
.. MATH::
N_\sigma \stackrel{\text{def}}{=} \mathop{span}( N\cap \sigma )
INPUT:
- either nothing or something that can be turned into an element of
this lattice.
OUTPUT:
- if no arguments were given, a :class:`toric sublattice
<sage.geometry.toric_lattice.ToricLattice_sublattice_with_basis>`,
otherwise the corresponding element of it.
.. NOTE::
* The sublattice spanned by the cone is the saturation of
the sublattice generated by the rays of the cone.
* See
:meth:`sage.geometry.cone.IntegralRayCollection.ray_basis`
if you only need a `\QQ`-basis.
* The returned lattice points are usually not rays of the
cone. In fact, for a non-smooth cone the rays do not
generate the sublattice `N_\sigma`, but only a finite
index sublattice.
EXAMPLES::
sage: cone = Cone([(1, 1, 1), (1, -1, 1), (-1, -1, 1), (-1, 1, 1)])
sage: cone.rays().basis()
N( 1, 1, 1),
N( 1, -1, 1),
N(-1, -1, 1)
in 3-d lattice N
sage: cone.rays().basis().matrix().det()
-4
sage: cone.sublattice()
Sublattice <N(-1, -1, 1), N(1, 0, 0), N(1, 1, 0)>
sage: matrix( cone.sublattice().gens() ).det()
1
Another example::
sage: c = Cone([(1,2,3), (4,-5,1)])
sage: c
2-d cone in 3-d lattice N
sage: c.rays()
N(1, 2, 3),
N(4, -5, 1)
in 3-d lattice N
sage: c.sublattice()
Sublattice <N(1, 2, 3), N(4, -5, 1)>
sage: c.sublattice(5, -3, 4)
N(5, -3, 4)
sage: c.sublattice(1, 0, 0)
Traceback (most recent call last):
...
TypeError: element (= [1, 0, 0]) is not in free module
"""
if "_sublattice" not in self.__dict__:
self._split_ambient_lattice()
if args or kwds:
return self._sublattice(*args, **kwds)
else:
return self._sublattice
def sublattice_quotient(self, *args, **kwds):
r"""
The quotient of the ambient lattice by the sublattice spanned
by the cone.
INPUT:
- either nothing or something that can be turned into an element of
this lattice.
OUTPUT:
- if no arguments were given, a :class:`quotient of a toric lattice
<sage.geometry.toric_lattice.ToricLattice_quotient>`,
otherwise the corresponding element of it.
EXAMPLES::
sage: C2_Z2 = Cone([(1,0),(1,2)]) # C^2/Z_2
sage: c1, c2 = C2_Z2.facets()
sage: c2.sublattice_quotient()
1-d lattice, quotient of 2-d lattice N by Sublattice <N(1, 2)>
sage: N = C2_Z2.lattice()
sage: n = N(1,1)
sage: n_bar = c2.sublattice_quotient(n); n_bar
N[1, 1]
sage: n_bar.lift()
N(1, 1)
sage: vector(n_bar)
(-1)
"""
if "_sublattice_quotient" not in self.__dict__:
self._sublattice_quotient = self.lattice() / self.sublattice()
if args or kwds:
return self._sublattice_quotient(*args, **kwds)
else:
return self._sublattice_quotient
def sublattice_complement(self, *args, **kwds):
r"""
A complement of the sublattice spanned by the cone.
In other words, :meth:`sublattice` and
:meth:`sublattice_complement` together form a
`\ZZ`-basis for the ambient :meth:`lattice()
<sage.geometry.cone.IntegralRayCollection.lattice>`.
In the notation of [Fulton]_, let `\sigma` be the given cone
and `N=` ``self.lattice()`` the ambient lattice. Then this
method returns
.. MATH::
N(\sigma) \stackrel{\text{def}}{=} N / N_\sigma
lifted (non-canonically) to a sublattice of `N`.
INPUT:
- either nothing or something that can be turned into an element of
this lattice.
OUTPUT:
- if no arguments were given, a :class:`toric sublattice
<sage.geometry.toric_lattice.ToricLattice_sublattice_with_basis>`,
otherwise the corresponding element of it.
EXAMPLES::
sage: C2_Z2 = Cone([(1,0),(1,2)]) # C^2/Z_2
sage: c1, c2 = C2_Z2.facets()
sage: c2.sublattice()
Sublattice <N(1, 2)>
sage: c2.sublattice_complement()
Sublattice <N(0, 1)>
A more complicated example::
sage: c = Cone([(1,2,3), (4,-5,1)])
sage: c.sublattice()
Sublattice <N(1, 2, 3), N(4, -5, 1)>
sage: c.sublattice_complement()
Sublattice <N(0, -6, -5)>
sage: m = matrix( c.sublattice().gens() + c.sublattice_complement().gens() )
sage: m
[ 1 2 3]
[ 4 -5 1]
[ 0 -6 -5]
sage: m.det()
-1
"""
if "_sublattice_complement" not in self.__dict__:
self._split_ambient_lattice()
if args or kwds:
return self._sublattice_complement(*args, **kwds)
else:
return self._sublattice_complement
def orthogonal_sublattice(self, *args, **kwds):
r"""
The sublattice (in the dual lattice) orthogonal to the
sublattice spanned by the cone.
Let `M=` ``self.dual_lattice()`` be the lattice dual to the
ambient lattice of the given cone `\sigma`. Then, in the
notation of [Fulton]_, this method returns the sublattice
.. MATH::
M(\sigma) \stackrel{\text{def}}{=}
\sigma^\perp \cap M
\subset M
INPUT:
- either nothing or something that can be turned into an element of
this lattice.
OUTPUT:
- if no arguments were given, a :class:`toric sublattice
<sage.geometry.toric_lattice.ToricLattice_sublattice_with_basis>`,
otherwise the corresponding element of it.
EXAMPLES::
sage: c = Cone([(1,1,1), (1,-1,1), (-1,-1,1), (-1,1,1)])
sage: c.orthogonal_sublattice()
Sublattice <>
sage: c12 = Cone([(1,1,1), (1,-1,1)])
sage: c12.sublattice()
Sublattice <N(1, -1, 1), N(0, 1, 0)>
sage: c12.orthogonal_sublattice()
Sublattice <M(1, 0, -1)>
"""
if "_orthogonal_sublattice" not in self.__dict__:
try:
self._orthogonal_sublattice = self.sublattice_quotient().dual()
except AttributeError:
self._orthogonal_sublattice = ZZ**(self.lattice().dimension() -
self.sublattice().dimension())
if args or kwds:
return self._orthogonal_sublattice(*args, **kwds)
else:
return self._orthogonal_sublattice
def relative_quotient(self, subcone):
r"""
The quotient of the spanned lattice by the lattice spanned by
a subcone.
In the notation of [Fulton]_, let `N` be the ambient lattice
and `N_\sigma` the sublattice spanned by the given cone
`\sigma`. If `\rho < \sigma` is a subcone, then `N_\rho` =
``rho.sublattice()`` is a saturated sublattice of `N_\sigma` =
``self.sublattice()``. This method returns the quotient
lattice. The lifts of the quotient generators are
`\dim(\sigma)-\dim(\rho)` linearly independent primitive
lattice lattice points that, together with `N_\rho`, generate
`N_\sigma`.
OUTPUT:
- :class:`toric lattice quotient
<sage.geometry.toric_lattice.ToricLattice_quotient>`.
.. NOTE::
* The quotient `N_\sigma / N_\rho` of spanned sublattices
has no torsion since the sublattice `N_\rho` is saturated.
* In the codimension one case, the generator of
`N_\sigma / N_\rho` is chosen to be in the same direction as the
image `\sigma / N_\rho`
EXAMPLES::
sage: sigma = Cone([(1,1,1,3),(1,-1,1,3),(-1,-1,1,3),(-1,1,1,3)])
sage: rho = Cone([(-1, -1, 1, 3), (-1, 1, 1, 3)])
sage: sigma.sublattice()
Sublattice <N(-1, -1, 1, 3), N(1, 0, 0, 0), N(1, 1, 0, 0)>
sage: rho.sublattice()
Sublattice <N(-1, 1, 1, 3), N(0, -1, 0, 0)>
sage: sigma.relative_quotient(rho)
1-d lattice, quotient
of Sublattice <N(-1, -1, 1, 3), N(1, 0, 0, 0), N(1, 1, 0, 0)>
by Sublattice <N(1, 0, -1, -3), N(0, 1, 0, 0)>
sage: sigma.relative_quotient(rho).gens()
(N[1, 1, 0, 0],)
More complicated example::
sage: rho = Cone([(1, 2, 3), (1, -1, 1)])
sage: sigma = Cone([(1, 2, 3), (1, -1, 1), (-1, 1, 1), (-1, -1, 1)])
sage: N_sigma = sigma.sublattice()
sage: N_sigma
Sublattice <N(-1, 1, 1), N(1, 2, 3), N(0, 1, 1)>
sage: N_rho = rho.sublattice()
sage: N_rho
Sublattice <N(1, -1, 1), N(1, 2, 3)>
sage: sigma.relative_quotient(rho).gens()
(N[0, 1, 1],)
sage: N = rho.lattice()
sage: N_sigma == N.span(N_rho.gens() + tuple(q.lift()
... for q in sigma.relative_quotient(rho).gens()))
True
Sign choice in the codimension one case::
sage: sigma1 = Cone([(1, 2, 3), (1, -1, 1), (-1, 1, 1), (-1, -1, 1)]) # 3d
sage: sigma2 = Cone([(1, 1, -1), (1, 2, 3), (1, -1, 1), (1, -1, -1)]) # 3d
sage: rho = sigma1.intersection(sigma2)
sage: rho.sublattice()
Sublattice <N(1, -1, 1), N(1, 2, 3)>
sage: sigma1.relative_quotient(rho)
1-d lattice, quotient
of Sublattice <N(-1, 1, 1), N(1, 2, 3), N(0, 1, 1)>
by Sublattice <N(1, 2, 3), N(0, 3, 2)>
sage: sigma1.relative_quotient(rho).gens()
(N[0, 1, 1],)
sage: sigma2.relative_quotient(rho).gens()
(N[-1, 0, -2],)
"""
try:
cached_values = self._relative_quotient
except AttributeError:
self._relative_quotient = {}
cached_values = self._relative_quotient
try:
return cached_values[subcone]
except KeyError:
pass
Ncone = self.sublattice()
Nsubcone = subcone.sublattice()
extra_ray = None
if Ncone.dimension()-Nsubcone.dimension()==1:
extra_ray = set(self.rays().set() - subcone.rays().set()).pop()
Q = Ncone.quotient(Nsubcone, positive_point=extra_ray)
assert Q.is_torsion_free()
cached_values[subcone] = Q
return Q
def relative_orthogonal_quotient(self, supercone):
r"""
The quotient of the dual spanned lattice by the dual of the
supercone's spanned lattice.
In the notation of [Fulton]_, if ``supercone`` = `\rho >
\sigma` = ``self`` is a cone that contains `\sigma` as a face,
then `M(\rho)` = ``supercone.orthogonal_sublattice()`` is a
saturated sublattice of `M(\sigma)` =
``self.orthogonal_sublattice()``. This method returns the
quotient lattice. The lifts of the quotient generators are
`\dim(\rho)-\dim(\sigma)` linearly independent M-lattice
lattice points that, together with `M(\rho)`, generate
`M(\sigma)`.
OUTPUT:
- :class:`toric lattice quotient
<sage.geometry.toric_lattice.ToricLattice_quotient>`.
If we call the output ``Mrho``, then
- ``Mrho.cover() == self.orthogonal_sublattice()``, and
- ``Mrho.relations() == supercone.orthogonal_sublattice()``.
.. NOTE::
* `M(\sigma) / M(\rho)` has no torsion since the sublattice
`M(\rho)` is saturated.
* In the codimension one case, (a lift of) the generator of
`M(\sigma) / M(\rho)` is chosen to be positive on `\sigma`.
EXAMPLES::
sage: rho = Cone([(1,1,1,3),(1,-1,1,3),(-1,-1,1,3),(-1,1,1,3)])
sage: rho.orthogonal_sublattice()
Sublattice <M(0, 0, 3, -1)>
sage: sigma = rho.facets()[2]
sage: sigma.orthogonal_sublattice()
Sublattice <M(0, 1, 1, 0), M(0, 0, 3, -1)>
sage: sigma.is_face_of(rho)
True
sage: Q = sigma.relative_orthogonal_quotient(rho); Q
1-d lattice, quotient
of Sublattice <M(0, 1, 1, 0), M(0, 0, 3, -1)>
by Sublattice <M(0, 0, 3, -1)>
sage: Q.gens()
(M[0, 1, 1, 0],)
Different codimension::
sage: rho = Cone([[1,-1,1,3],[-1,-1,1,3]])
sage: sigma = rho.facets()[0]
sage: sigma.orthogonal_sublattice()
Sublattice <M(1, 0, 2, -1), M(0, 1, 1, 0), M(0, 0, 3, -1)>
sage: rho.orthogonal_sublattice()
Sublattice <M(0, 1, 1, 0), M(0, 0, 3, -1)>
sage: sigma.relative_orthogonal_quotient(rho).gens()
(M[-1, 0, -2, 1],)
Sign choice in the codimension one case::
sage: sigma1 = Cone([(1, 2, 3), (1, -1, 1), (-1, 1, 1), (-1, -1, 1)]) # 3d
sage: sigma2 = Cone([(1, 1, -1), (1, 2, 3), (1, -1, 1), (1, -1, -1)]) # 3d
sage: rho = sigma1.intersection(sigma2)
sage: rho.relative_orthogonal_quotient(sigma1).gens()
(M[-5, -2, 3],)
sage: rho.relative_orthogonal_quotient(sigma2).gens()
(M[5, 2, -3],)
"""
try:
cached_values = self._relative_orthogonal_quotient
except AttributeError:
self._relative_orthogonal_quotient = {}
cached_values = self._relative_orthogonal_quotient
try:
return cached_values[supercone]
except KeyError:
pass
Mcone = self.orthogonal_sublattice()
Msupercone = supercone.orthogonal_sublattice()
extra_ray = None
if Mcone.dimension()-Msupercone.dimension()==1:
extra_ray = set(supercone.rays().set() - self.rays().set()).pop()
Q = Mcone.quotient(Msupercone, positive_dual_point=extra_ray)
assert Q.is_torsion_free()
cached_values[supercone] = Q
return Q
def semigroup_generators(self):
r"""
Return generators for the semigroup of lattice points of ``self``.
OUTPUT:
- a :class:`~sage.geometry.point_collection.PointCollection`
of lattice points generating the semigroup of lattice points
contained in ``self``.
.. note::
No attempt is made to return a minimal set of generators, see
:meth:`Hilbert_basis` for that.
EXAMPLES:
The following command ensures that the output ordering in the examples
below is independent of TOPCOM, you don't have to use it::
sage: PointConfiguration.set_engine('internal')
We start with a simple case of a non-smooth 2-dimensional cone::
sage: Cone([ (1,0), (1,2) ]).semigroup_generators()
N(1, 1),
N(1, 0),
N(1, 2)
in 2-d lattice N
A non-simplicial cone works, too::
sage: cone = Cone([(3,0,-1), (1,-1,0), (0,1,0), (0,0,1)])
sage: cone.semigroup_generators()
(N(1, 0, 0), N(0, 0, 1), N(0, 1, 0), N(3, 0, -1), N(1, -1, 0))
GAP's toric package thinks this is challenging::
sage: cone = Cone([[1,2,3,4],[0,1,0,7],[3,1,0,2],[0,0,1,0]]).dual()
sage: len( cone.semigroup_generators() )
2806
The cone need not be strictly convex::
sage: halfplane = Cone([(1,0),(2,1),(-1,0)])
sage: halfplane.semigroup_generators()
(N(0, 1), N(1, 0), N(-1, 0))
sage: line = Cone([(1,1,1),(-1,-1,-1)])
sage: line.semigroup_generators()
(N(1, 1, 1), N(-1, -1, -1))
sage: wedge = Cone([ (1,0,0), (1,2,0), (0,0,1), (0,0,-1) ])
sage: wedge.semigroup_generators()
(N(1, 0, 0), N(1, 1, 0), N(1, 2, 0), N(0, 0, 1), N(0, 0, -1))
Nor does it have to be full-dimensional (see
http://trac.sagemath.org/sage_trac/ticket/11312)::
sage: Cone([(1,1,0), (-1,1,0)]).semigroup_generators()
N( 0, 1, 0),
N( 1, 1, 0),
N(-1, 1, 0)
in 3-d lattice N
Neither full-dimensional nor simplicial::
sage: A = matrix([(1, 3, 0), (-1, 0, 1), (1, 1, -2), (15, -2, 0)])
sage: A.elementary_divisors()
[1, 1, 1, 0]
sage: cone3d = Cone([(3,0,-1), (1,-1,0), (0,1,0), (0,0,1)])
sage: rays = [ A*vector(v) for v in cone3d.rays() ]
sage: gens = Cone(rays).semigroup_generators(); gens
(N(1, -1, 1, 15), N(0, 1, -2, 0), N(-2, -1, 0, 17), N(3, -4, 5, 45), N(3, 0, 1, -2))
sage: set(map(tuple,gens)) == set([ tuple(A*r) for r in cone3d.semigroup_generators() ])
True
TESTS::
sage: len(Cone(identity_matrix(10).rows()).semigroup_generators())
10
sage: trivial_cone = Cone([], lattice=ToricLattice(3))
sage: trivial_cone.semigroup_generators()
Empty collection
in 3-d lattice N
ALGORITHM:
If the cone is not simplicial, it is first triangulated. Each
simplicial subcone has the integral points of the spaned
parallelotope as generators. This is the first step of the
primal Normaliz algorithm, see [Normaliz]_. For each
simplicial cone (of dimension `d`), the integral points of the
open parallelotope
.. math::
par \langle x_1, \dots, x_d \rangle =
\ZZ^n \cap
\left\{
q_1 x_1 + \cdots +q_d x_d
:~
0 \leq q_i < 1
\right\}
are then computed [BrunsKoch]_.
Finally, the the union of the generators of all simplicial
subcones is returned.
REFERENCES:
.. [BrunsKoch]
W. Bruns and R. Koch,
Computing the integral closure of an affine semigroup.
Uni. Iaggelonicae Acta Math. 39, (2001), 59-70
"""
N = self.lattice()
if not self.is_simplicial():
from sage.geometry.triangulation.point_configuration \
import PointConfiguration
origin = self.nrays()
pc = PointConfiguration(tuple(self.rays()) + (N(0),), star=origin)
triangulation = pc.triangulate()
subcones = [ Cone([self.ray(i) for i in simplex if i!=origin],
lattice=N, check=False)
for simplex in triangulation ]
gens = set()
for cone in subcones:
gens.update(cone.semigroup_generators())
return tuple(gens)
gens = list(parallelotope_points(self.rays(), N)) + list(self.rays())
gens = filter(lambda v: gcd(v) == 1, gens)
return PointCollection(gens, N)
@cached_method
def Hilbert_basis(self):
r"""
Return the Hilbert basis of the cone.
Given a strictly convex cone `C\subset \RR^d`, the Hilbert
basis of `C` is the set of all irreducible elements in the
semigroup `C\cap \ZZ^d`. It is the unique minimal generating
set over `\ZZ` for the integral points `C\cap \ZZ^d`.
If the cone `C` is not strictly convex, this method finds the
(unique) minimial set of lattice points that need to be added
to the defining rays of the cone to generate the whole
semigroup `C\cap \ZZ^d`. But because the rays of the cone are
not unique nor necessarily minimal in this case, neither is
the returned generating set (consisting of the rays plus
additional generators).
See also :meth:`semigroup_generators` if you are not
interested in a minimal set of generators.
OUTPUT:
- a
:class:`~sage.geometry.point_collection.PointCollection`. The
rays of ``self`` are the first ``self.nrays()`` entries.
EXAMPLES:
The following command ensures that the output ordering in the examples
below is independent of TOPCOM, you don't have to use it::
sage: PointConfiguration.set_engine('internal')
We start with a simple case of a non-smooth 2-dimensional cone::
sage: Cone([ (1,0), (1,2) ]).Hilbert_basis()
N(1, 0),
N(1, 2),
N(1, 1)
in 2-d lattice N
Two more complicated example from GAP/toric::
sage: Cone([[1,0],[3,4]]).dual().Hilbert_basis()
M(0, 1),
M(4, -3),
M(3, -2),
M(2, -1),
M(1, 0)
in 2-d lattice M
sage: cone = Cone([[1,2,3,4],[0,1,0,7],[3,1,0,2],[0,0,1,0]]).dual()
sage: cone.Hilbert_basis() # long time
M(10, -7, 0, 1),
M(-5, 21, 0, -3),
M( 0, -2, 0, 1),
M(15, -63, 25, 9),
M( 2, -3, 0, 1),
M( 1, -4, 1, 1),
M(-1, 3, 0, 0),
M( 4, -4, 0, 1),
M( 1, -5, 2, 1),
M( 3, -5, 1, 1),
M( 6, -5, 0, 1),
M( 3, -13, 5, 2),
M( 2, -6, 2, 1),
M( 5, -6, 1, 1),
M( 0, 1, 0, 0),
M( 8, -6, 0, 1),
M(-2, 8, 0, -1),
M(10, -42, 17, 6),
M( 7, -28, 11, 4),
M( 5, -21, 9, 3),
M( 6, -21, 8, 3),
M( 5, -14, 5, 2),
M( 2, -7, 3, 1),
M( 4, -7, 2, 1),
M( 7, -7, 1, 1),
M( 0, 0, 1, 0),
M(-3, 14, 0, -2),
M(-1, 7, 0, -1),
M( 1, 0, 0, 0)
in 4-d lattice M
Not a strictly convex cone::
sage: wedge = Cone([ (1,0,0), (1,2,0), (0,0,1), (0,0,-1) ])
sage: wedge.semigroup_generators()
(N(1, 0, 0), N(1, 1, 0), N(1, 2, 0), N(0, 0, 1), N(0, 0, -1))
sage: wedge.Hilbert_basis()
N(1, 2, 0),
N(1, 0, 0),
N(0, 0, 1),
N(0, 0, -1),
N(1, 1, 0)
in 3-d lattice N
Not full-dimensional cones are ok, too (see
http://trac.sagemath.org/sage_trac/ticket/11312)::
sage: Cone([(1,1,0), (-1,1,0)]).Hilbert_basis()
N( 1, 1, 0),
N(-1, 1, 0),
N( 0, 1, 0)
in 3-d lattice N
ALGORITHM:
The primal Normaliz algorithm, see [Normaliz]_.
REFERENCES:
.. [Normaliz]
Winfried Bruns, Bogdan Ichim, and Christof Soeger:
Normaliz.
http://www.mathematik.uni-osnabrueck.de/normaliz/
"""
if self.is_strictly_convex():
def not_in_linear_subspace(x): return True
else:
linear_subspace = self.linear_subspace()
def not_in_linear_subspace(x): return not x in linear_subspace
irreducible = list(self.rays())
gens = list(self.semigroup_generators())
for x in irreducible:
try:
gens.remove(x)
except ValueError:
pass
while gens:
x = gens.pop()
if any(not_in_linear_subspace(y) and x-y in self
for y in irreducible+gens):
continue
irreducible.append(x)
if len(irreducible) == self.nrays():
return self.rays()
else:
return PointCollection(irreducible, self.lattice())
def Hilbert_coefficients(self, point):
r"""
Return the expansion coefficients of ``point`` with respect to
:meth:`Hilbert_basis`.
INPUT:
- ``point`` -- a :meth:`~IntegralRayCollection.lattice` point
in the cone, or something that can be converted to a
point. For example, a list or tuple of integers.
OUTPUT:
A `\ZZ`-vector of length ``len(self.Hilbert_basis())`` with nonnegative
components.
.. note::
Since the Hilbert basis elements are not necessarily linearly
independent, the expansion coefficients are not unique. However,
this method will always return the same expansion coefficients when
invoked with the same argument.
EXAMPLES::
sage: cone = Cone([(1,0),(0,1)])
sage: cone.rays()
N(1, 0),
N(0, 1)
in 2-d lattice N
sage: cone.Hilbert_coefficients([3,2])
(3, 2)
A more complicated example::
sage: N = ToricLattice(2)
sage: cone = Cone([N(1,0),N(1,2)])
sage: cone.Hilbert_basis()
N(1, 0),
N(1, 2),
N(1, 1)
in 2-d lattice N
sage: cone.Hilbert_coefficients( N(1,1) )
(0, 0, 1)
The cone need not be strictly convex::
sage: N = ToricLattice(3)
sage: cone = Cone([N(1,0,0),N(1,2,0),N(0,0,1),N(0,0,-1)])
sage: cone.Hilbert_basis()
N(1, 2, 0),
N(1, 0, 0),
N(0, 0, 1),
N(0, 0, -1),
N(1, 1, 0)
in 3-d lattice N
sage: cone.Hilbert_coefficients( N(1,1,3) )
(0, 0, 3, 0, 1)
"""
point = self.lattice()(point)
if point not in self:
raise ValueError('The given point is not in the cone!')
basis = self.Hilbert_basis()
from sage.numerical.mip import MixedIntegerLinearProgram
p = MixedIntegerLinearProgram(maximization=False)
p.set_objective(None)
x = p.new_variable(integer=True)
x = [ x[i] for i in range(0,len(basis)) ]
for i in range(0,self.lattice_dim()):
p.add_constraint(sum(b[i]*x[j] for j,b in enumerate(basis)) == point[i])
p.solve()
return vector(ZZ, p.get_values(x))
