Introduction
The polyhedral geometry part of OSCAR provides functionality for handling
- convex polytopes, unbounded polyhedra and cones
- polyhedral fans
- linear programs
General textbooks offering details on theory and algorithms include:
Type compatibility
When working in polyhedral geometry it can prove advantageous to have various input formats for the same kind of re-occurring quantitative input information. This example shows three different ways to write the points whose convex hull is to be computed, all resulting in identical Polyhedron
objects:
julia> P = convex_hull([1 0 0; 0 0 1])
Polyhedron in ambient dimension 3
julia> P == convex_hull([[1, 0, 0], [0, 0, 1]])
true
julia> P == convex_hull(vertices(P))
true
convex_hull
is only one of many functions and constructors supporting this behavior, and there are also more types that can be described this way besides PointVector
. Whenever the docs state an argument is required to be of type AbstractCollection[ElType]
(where ElType
is the Oscar
type of single instances described in this collection), the user can choose the input to follow any of the corresponding notions below.
Vectors
While RayVector
s can not be used do describe PointVector
s (and vice versa), matrices are generally allowed.
AbstractCollection[PointVector]
can be given as:
Type | A PointVector corresponds to... |
---|---|
AbstractVector{<:ṔointVector} | an element of the vector. |
AbstractVector{<:AbstractVector} | an element of the vector. |
AbstractMatrix /MatElem | a row of the matrix. |
AbstractVector /PointVector | the vector itself (only one PointVector is described). |
SubObjectIterator{<:PointVector} | an element of the iterator. |
AbstractCollection[RayVector]
can be given as:
Type | A RayVector corresponds to... |
---|---|
AbstractVector{<:RayVector} | an element of the vector. |
AbstractVector{<:AbstractVector} | an element of the vector. |
AbstractMatrix /MatElem | a row of the matrix. |
AbstractVector /RayVector | the vector itself (only one RayVector is described). |
SubObjectIterator{<:RayVector} | an element of the iterator. |
Halfspaces and Hyperplanes
These collections allow to mix up affine halfspaces/hyperplanes and their linear counterparts, but note that an error will be produced when trying to convert an affine description with bias not equal to zero to a linear description.
AbstractCollection[LinearHalfspace]
can be given as:
Type | A LinearHalfspace corresponds to... |
---|---|
AbstractVector{<:Halfspace} | an element of the vector. |
AbstractMatrix /MatElem A | the halfspace with normal vector A[i, :] . |
AbstractVector{<:AbstractVector} A | the halfspace with normal vector A[i] . |
SubObjectIterator{<:Halfspace} | an element of the iterator. |
AbstractCollection[LinearHyperplane]
can be given as:
Type | A LinearHyperplane corresponds to... |
---|---|
AbstractVector{<:Hyperplane} | an element of the vector. |
AbstractMatrix /MatElem A | the hyperplane with normal vector A[i, :] . |
AbstractVector{<:AbstractVector} A | the hyperplane with normal vector A[i] . |
SubObjectIterator{<:Hyperplane} | an element of the iterator. |
AbstractCollection[AffineHalfspace]
can be given as:
Type | An AffineHalfspace corresponds to... |
---|---|
AbstractVector{<:Halfspace} | an element of the vector. |
Tuple over matrix A and vector b | the affine halfspace with normal vector A[i, :] and bias b[i] . |
SubObjectIterator{<:Halfspace} | an element of the iterator. |
AbstractCollection[AffineHyperplane]
can be given as:
Type | An AffineHyperplane corresponds to... |
---|---|
AbstractVector{<:Hyperplane} | an element of the vector. |
Tuple over matrix A and vector b | the affine hyperplane with normal vector A[i, :] and bias b[i] . |
SubObjectIterator{<:Hyperplane} | an element of the iterator. |
IncidenceMatrix
Some methods will require input or return output in form of an IncidenceMatrix
.
IncidenceMatrix
— Type IncidenceMatrix
A matrix with boolean entries. Each row corresponds to a fixed element of a collection of mathematical objects and the same holds for the columns and a second (possibly equal) collection. A 1
at entry (i, j)
is interpreted as an incidence between object i
of the first collection and object j
of the second one.
Examples
Note that the input and print of an IncidenceMatrix
lists the non-zero indices for each row.
julia> IM = IncidenceMatrix([[1,2,3],[4,5,6]])
2×6 IncidenceMatrix
[1, 2, 3]
[4, 5, 6]
julia> IM[1, 2]
true
julia> IM[2, 3]
false
julia> IM[:, 4]
2-element SparseVectorBool
[2]
From the example it can be seen that this type supports julia
's matrix functionality. There are also functions to retrieve specific rows or columns as a Set
over the non-zero indices.
row
— Method row(i::IncidenceMatrix, n::Int)
Return the indices where the n
-th row of i
is true
, as a Set{Int}
.
Examples
julia> IM = IncidenceMatrix([[1,2,3],[4,5,6]])
2×6 IncidenceMatrix
[1, 2, 3]
[4, 5, 6]
julia> row(IM, 2)
Set{Int64} with 3 elements:
5
4
6
column
— Method column(i::IncidenceMatrix, n::Int)
Return the indices where the n
-th column of i
is true
, as a Set{Int}
.
Examples
julia> IM = IncidenceMatrix([[1,2,3],[4,5,6]])
2×6 IncidenceMatrix
[1, 2, 3]
[4, 5, 6]
julia> column(IM, 5)
Set{Int64} with 1 element:
2
A typical application is the assignment of rays to the cones of a polyhedral fan for its construction, see polyhedral_fan
.
Visualization
Lower dimensional polyhedral objects can be visualized through polymake's backend.
visualize
— Methodvisualize(P::Union{Polyhedron, Cone, PolyhedralFan, PolyhedralComplex})
Visualize a polyhedral object of dimension at most four (in 3-space). In dimensions up to 3 a usual embedding is shown. Four-dimensional polytopes are visualized as a Schlegel diagram, which is a projection onto one of the facets; e.g., see Chapter 5 of Günter M. Ziegler (1995).
In higher dimensions there is no standard method; use projections to lower dimensions or try ideas from Ewgenij Gawrilow, Michael Joswig, Thilo Rörig, Nikolaus Witte (2010).
Serialization
Most objects from the polyhedral geometry section can be saved through the polymake interface in the background. These functions are documented in the subsections on the different objects. The format of the files is JSON and you can find details of the specification here.
More details on the serialization, albeit concerning the older XML format, can be found in Ewgenij Gawrilow, Simon Hampe, Michael Joswig (2016). Even though the underlying format changed to JSON, the abstract mathematical structure of the data files is still the same.
Contact
Please direct questions about this part of OSCAR to the following people:
- Taylor Brysiewicz,
- Michael Joswig,
- Lars Kastner,
- Benjamin Lorenz.
You can ask questions in the OSCAR Slack.
Alternatively, you can raise an issue on github.