add additional methods to NNC_polyhedron class

Author: ComboProblem

pplite/__init__.py

@@ -10,7 +10,7 @@
 - Acadia Larsen (2024): initial version.
 """
 
-__version__ = "0.0.53"
+__version__ = "0.0.54"
 
 from .linear_algebra import (
         Variable, Linear_Expression, Affine_Expression

pplite/constraint.pyx

@@ -172,7 +172,7 @@ cdef class Constraint(object):
         INPUT: None
         OUPUT: A tuple of coefficients 
         """
-        
+        raise NotImplementedError
 
     def linear_form(self):
         """
@@ -587,10 +587,10 @@ cdef _make_Constraint_from_richcmp(lhs_, rhs_, op):
             raise NotImplementedError
         else:
             assert(False)
-    if isinstance(lhs_, Variable): # variable not explitly declared. promote var to linear expression and compare. 
+    if isinstance(lhs_, Variable): # Variable not explicitly declared. Promote var to linear expression and compare. 
         lhs_ = Linear_Expression(lhs_)
         return _make_Constraint_from_richcmp(lhs_, rhs_, op)
-    if isinstance(rhs_, Variable): # variable not explitly declared. promote var to linear expression and compare. 
+    if isinstance(rhs_, Variable): # Variable not explicitly declared. Promote var to linear expression and compare. 
         rhs_ = Linear_Expression(rhs_)
         return _make_Constraint_from_richcmp(lhs_, rhs_, op)
 
@@ -605,7 +605,6 @@ cdef _wrap_Constraint(Con constraint):
 
 
 # Reproduction of these functions here is necessary. Removing this causes things to break.
-# Investigation is pending.
 cdef FLINT_Integer_to_Python(FLINT_Integer& integer):
     r""" Converts FLINT_Integer to python integer."""
     cdef mpz_t new_int
@@ -631,7 +630,7 @@ cdef FLINT_Integer Python_int_to_FLINT_Integer(integer):
 
 def FLINT_Integer_Conversion_Check(possible_integer):
     """
-    Checks a python object is convertable to a FLINT_Integer.
+    Checks a python object is convertible to a FLINT_Integer.
 
     Input: Object
 

pplite/generators.pyx

@@ -460,8 +460,6 @@ def Ray(linear_expression):
 ### Helper Functions ###
 ########################
 
-# TODO migrate helper functions to a single module. 
-
 cdef GenType string_to_GenType(t):
     """
     Converts a string to an enum pplite::GenType.

pplite/linear_algebra.pyx

@@ -29,7 +29,7 @@ cdef FLINT_Integer Python_int_to_FLINT_Integer(integer):
         fmpz_init(x)
         fmpz_set_si(x, integer)
         return FLINT_Integer(x)
-    if MPZ_Check(integer): # is this okay?
+    if MPZ_Check(integer): # This is a little hacky...
         y = <fmpz> integer
         return FLINT_Integer(y)
     raise ValueError("Integer Conversion Failed")
@@ -453,11 +453,9 @@ cdef class Linear_Expression(object):
     mpz(1)
     >>> expr.coefficient(Variable(124))
     mpz(0)
-
-    String, rationals and floating point types are accepted as long as they
-    represent exact integers:
     """
-    # TODO: Finish Tests/claim above.
+    # TODO: Check that string, rationals and floating point types are accepted as long as they
+    # represent exact integers.
     def __init__(self, *args):
         """
         The Cython constructor.

pplite/polyhedron.pyx

@@ -276,7 +276,7 @@ cdef class NNC_Polyhedron(object):
         raise TypeError("other_poly needs to be of :class:`NNC_Polyhedron`")
 
     def get_bounding_box(self):
-        pass
+        raise NotImplementedError
 
     def boxed_contains(self, other_poly):
         cdef Poly* yy
@@ -372,7 +372,7 @@ cdef class NNC_Polyhedron(object):
         return i
 
     def _get_boundes_itv(self, itv_expr):
-        pass
+        raise NotImplementedError
 
     def get_bounds(self, variable_or_affine_expr):
         if isinstance(variable_or_affine_expr, Variable):
@@ -382,27 +382,31 @@ cdef class NNC_Polyhedron(object):
         raise TypeError("A :class:`Variable` or a :class:`Affine_Expression` should be passed into this method.")
 
     def get_unconstrainted(self):
-        pass
+        raise NotImplementedError
 
+
+# For both the constraints and generators methods should be implemented via cons_sys and gens_sys. 
+# At the moment, we use the copy constructor because it was easier to write. 
     def constraints(self):
-        # Access constraints indirectly via copy_cons()
-        # TODO: Properly implement via sys and Cons_Proxy in Poly_Impl
+        """
+        Returns a list of :class:`Constraint` of the polyhedron. 
+
+        Note: the constraints space dim is not necessarily the ambient space dim of the poly. 
+        """
         cdef Cons constraint_vector 
         constraint_vector = self.thisptr[0].copy_cons()
         result = []
         cdef unsigned int index = constraint_vector.size() # hacky way to iterate over vectors
         for i in range(index):
-            c = Constraint()
+            c = Constraint(i)
             c.thisptr = new Con(constraint_vector[i])
             result.append(c)
         return result
 
     def generators(self):
         """
-        Returns a list of :class:`PPliteGenerator`.
+        Returns a list of :class:`PPliteGenerator`of the polyhedron.
         """
-        # Access constraints indirectly via copy_cons()
-        # TODO: Properly implement via sys and Cons_Proxy in Poly_Impl
         cdef Gens generator_vector 
         generator_vector = self.thisptr[0].copy_gens()
         result = []
@@ -414,8 +418,7 @@ cdef class NNC_Polyhedron(object):
         return result
 
     def normalized_constraints(self):
-        # TODO implement once Cons_Proxy is implemented. 
-        pass
+        raise NotImplementedError
 
     def num_min_constrains(self):
         return self.thisptr[0].num_min_cons()
@@ -461,6 +464,9 @@ cdef class NNC_Polyhedron(object):
         self.thisptr[0].set_empty()
 
     def set_topology(self, topology):
+        """
+        Sets the topology of the NNC polyhedron as either "closed" or "nnc".
+        """
         cdef Topol tt
         tt = string_to_Topol(topology)
         self.thisptr[0].set_topology(tt)
@@ -585,8 +591,9 @@ cdef class NNC_Polyhedron(object):
             v = (<Variable> variable).thisptr
             self.thisptr[0].unconstrain(v[0])
 
-    def unconstain_many(self, iter_of_var_or_index_set):
-        pass
+    def unconstain_many(self, iter_of_vars):
+        for var in iter_of_vars:
+            self.unconstain(var)
 
     def intersection_assign(self, other_poly):
         if isinstance(other_poly, NNC_Polyhedron):
@@ -640,20 +647,32 @@ cdef class NNC_Polyhedron(object):
         den = Python_int_to_FLINT_Integer(denominator)
         self.thisptr[0].affine_preimage(var[0], expr, inhomo, den)        
 
-    # TODO: Implement these   
-    def parallel_affine_image(self, args):
-        pass
+    def parallel_affine_image(self):
+        raise NotImplementedError
 
     def widing_assign(self, args):
-        pass
+        raise NotImplementedError
 
     def time_elapse_assign(self, other_poly):
         if isinstance(other_poly, NNC_Polyhedron):
             y = (<NNC_Polyhedron> other_poly).thisptr
             self.thisptr[0].time_elapse_assign(y[0])
 
-    def minimize(self):
-        self.thisptr[0].minimize()
+    def split(self, constraint, topology):
+        if isinstance(constraint, Constraint):
+            con = (<Constraint> constraint).thisptr
+        cdef Topol tt
+        tt = string_to_Topol(topology)
+        new_poly = NNC_Polyhedron()
+        new_poly.thisptr = new Poly(self.thisptr[0].split(con[0], tt))
+        return new_poly
+
+    def integral_split(self, constraint):
+        if isinstance(constraint, Constraint):
+            con = (<Constraint> constraint).thisptr
+        new_poly = NNC_Polyhedron()
+        new_poly.thisptr = new Poly(self.thisptr[0].integral_split(con[0]))
+        return new_poly
 
     def add_space_dimensions(self, dim_to_add, projection):
         cdef cppbool project
@@ -668,6 +687,26 @@ cdef class NNC_Polyhedron(object):
         else:
             raise TypeError("dim_to_add needs to be an ``int``.")
 
+    def concatenate_assign(self, poly):
+        if isinstance(poly, NNC_Polyhedron):
+            p = (<NNC_Polyhedron>  poly).thisptr
+        self.thisptr[0].concatenate_assign(p[0])
+
+    def remove_higher_space_dims(self, new_dim):
+        cdef dim_type d
+        d = Python_int_to_FLINT_Integer(new_dim)
+        self.thisptr[0].remove_higher_space_dims(d)
+
+    def expand_space_dim(self, variable, dim_m):
+        cdef dim_type d
+        d = Python_int_to_FLINT_Integer(dim_m)
+        if isinstance(variable, Variable):
+            var = (<Variable> variable).thisptr
+        self.thisptr[0].expand_space_dim(var[0], d)
+
+    def minimize(self):
+        self.thisptr[0].minimize()
+
 #####################################
 ### Poly_Con_Rel and Poly_Gen_Rel ###
 #####################################
@@ -774,9 +813,6 @@ cdef class Polyhedron_Generator_Rel(object):
     def implies(self, Polyhedron_Generator_Rel y):
         return self.thisptr.implies(y.thisptr[0])
 
-
-# TODO Migrate helper functions to a helper function module.
-
 #########################
 ###  Helper Functions ###
 #########################
@@ -799,24 +835,4 @@ cdef Spec_Elem string_to_Spec_Elem(s):
     if  s == "universe":
         ss = Spec_Elem.UNIVERSE
         return ss
-    raise ValueError("Unrecognized string {0}.".format(s))
-
-
-
-
-# cdef Poly_Con_Rel _new_Poly_Con_Rel(s):
-#     if s == "nothing":
-#         return PPlite_NOTHING
-
-#     raise ValueError("Unrecognized string {0}.".format(s))
-
-# cdef _new_Poly_Con_Rel_Nothing():
-#     cdef Poly_Con_Rel rel = Polyhedron_Constraint_Rel()
-#     rel.thisptr = new NOTHING
-#     return rel
-
-
-# cdef _new_Poly_Gen_Rel():
-#     rel = Polyhedron_Generator_Rel()
-#     rel.thisptr = new Poly_Gen_Rel()
-#     return rel
+    raise ValueError("Unrecognized string {0}.".format(s))

pplite/pplite_decl.pxd

@@ -565,6 +565,7 @@ cdef extern from "pplite/pplite.hh" namespace "pplite":
 
 
 # "pplite/Poly.hh"
+    cdef cppclass Poly_Impl
     cdef cppclass Poly_Impl:
         # enum Status:
         #     EMPTY
@@ -578,29 +579,34 @@ cdef extern from "pplite/pplite.hh" namespace "pplite":
         ctypedef struct gs "Sys<Gens>":
             pass
 
+# This comes down to figuring out the namespace schematics
+# Cons_Proxy is an alias for Mater_Sys<Sys<Cons>, Poly_Impl>
+# using Cons_Proxy = Mater_Sys<Sys<Cons>, Poly_Impl>;
+# using is something that can be redone as a typedef
+# How does the using keyword play into the cython side in terms of alising?
+            
+    # ctypedef struct Cons_Proxy: # "pplite::Mater_Sys<pplite::Poly_Impl::Sys<pplite::Cons>, pplite::Poly_Impl>": # Cons_Proxy
+    #     pass 
 
-        # ctypedef struct Cons_Proxy "pplite::Mater_Sys<pplite::Poly_Impl::Sys<pplite::Cons>, pplite::Poly_Impl>": # Cons_Proxy
-        #     pass 
-
-        # ctypedef struct Gens_Proxy "pplite::Mater_Sys<pplite::Poly_Impl::Sys<pplite::Gens>, pplite::Poly_Impl>": # Gens_Proxy
-        #     pass  
-    
+    # ctypedef srutct Gens_Proxy: # "pplite::Mater_Sys<pplite::Poly_Impl::Sys<pplite::Gens>, pplite::Poly_Impl>": # Gens_Proxy
+    #     pass  
 
+    cdef cppclass Poly
     cdef cppclass Poly:
-        Impl cppclass "pplite::Poly::Poly_Impl" # guess on how to alias this
+        Impl cppclass "pplite::Poly_Impl" # guess on how to alias this
         Poly(dim_type d, Spec_Elem s, Topol t)
         Poly(dim_type d, Topol t, Spec_Elem s)
         Poly(Spec_Elem s, Topol t, dim_type d)
         Poly(Topol t, dim_type d, Spec_Elem s)
         Poly(Topol t, Spec_Elem s, dim_type d)
         Poly(Poly& y)
         Poly& operator=(Poly& y)
-        Impl impl()
+        Impl impl() 
   # /* Types */
-        ctypedef struct Cons_Proxy "Impl::Cons_Proxy":   # using Impl::Cons_Proxy;
+        ctypedef struct Cons_Proxy "Cons_Proxy":   # using Impl::Cons_Proxy;
             pass # treat as container protocol, just try to iterate over it and don't worry too much about wrapping properly
-            # these are c++ implementation details 
-        ctypedef struct Gens_Proxy "Impl::Gens_Proxy":   # using Impl::Gens_Proxy;
+        #     # these are c++ implementation details 
+        ctypedef struct Gens_Proxy "Gens_Proxy":   # using Impl::Gens_Proxy;
             pass
     # /* Predicates */
         cppbool is_necessarily_closed()
@@ -690,6 +696,7 @@ cdef extern from "pplite/pplite.hh" namespace "pplite":
 
 
 # PPlite/Poly_Rel.hh
+    cdef cppclass Poly_Con_Rel
     cdef cppclass Poly_Con_Rel:
         ctypedef unsigned int Impl
         Poly_Con_Rel()
@@ -709,6 +716,7 @@ cdef extern from "pplite/pplite.hh" namespace "pplite":
     cdef Poly_Con_Rel PPlite_IS_INCLUDED "pplite::Poly_Con_Rel::is_included"()
     cdef Poly_Con_Rel PPlite_SATURATES "pplite::Poly_Con_Rel::saturates"()
 
+    cdef cppclass Poly_Gen_Rel
     cdef cppclass Poly_Gen_Rel:
         ctypedef unsigned int Impl
         Poly_Gen_Rel()