#############################################################################
##
## ConvexObject.gd Convex package Sebastian Gutsche
##
## Copyright 2011-2012 Lehrstuhl B für Mathematik, RWTH Aachen
##
## The Main Object to be viewed, is almost everything that has a number ;).
##
#############################################################################
## <#GAPDoc Label="IsConvexObject">
##
##
## true or false
##
## The &GAP; category of convex objects, the main category of this package.
##
##
## <#/GAPDoc>
##
DeclareCategory( "IsConvexObject",
IsObject );
DeclareRepresentation( "IsExternalConvexObjectRep",
IsConvexObject and IsAttributeStoringRep,
[ ]
);
DeclareRepresentation( "IsInternalConvexObjectRep",
IsConvexObject and IsAttributeStoringRep,
[ ]
);
################################
##
## Attributes
##
################################
## <#GAPDoc Label="ExternalObject">
##
##
## an external object
##
## Returns the external object contained in the combinatorical object conv,
## if there is one.
##
##
## <#/GAPDoc>
##
DeclareAttribute( "ExternalObject",
IsConvexObject );
## <#GAPDoc Label="Dimension">
##
##
## an integer
##
## Returns the combinatorial dimension of the convex object conv. This is the
## dimension of the smallest space i which conv can be embedded.
##
##
## <#/GAPDoc>
##
DeclareAttribute( "Dimension",
IsConvexObject );
## <#GAPDoc Label="AmbientSpaceDimension">
##
##
## an integer
##
## Returns the dimension of the ambient space of the object conv.
##
##
## <#/GAPDoc>
##
DeclareAttribute( "AmbientSpaceDimension",
IsConvexObject );
## <#GAPDoc Label="ContainingGrid">
##
##
## a homalg module
##
## Returns the ambient space of the object conv as a homalg module.
##
##
## <#/GAPDoc>
##
DeclareAttribute( "ContainingGrid",
IsConvexObject );
################################
##
## Properties
##
################################
## <#GAPDoc Label="IsFullDimensional">
##
##
## true or false
##
## Checks if the combinatorial dimension of the convex object conv is the same
## as the dimension of the ambient space.
##
##
## <#/GAPDoc>
##
DeclareProperty( "IsFullDimensional",
IsConvexObject );
################################
##
## Methods
##
################################
## <#GAPDoc Label="DrawObject">
##
##
## 0
##
## Draws a nice picture of the object conv, if your computer supports Java.
## As a side effect, you might not be able to exit &GAP; anymore.
##
##
## <#/GAPDoc>
##
DeclareOperation( "DrawObject",
[ IsConvexObject ] );
################################
##
## Basics
##
################################
## <#GAPDoc Label="WeakPointerToExternalObject">
##
##
## a pointer
##
## Returns a pointer to an external object which is the basis of conv.
## This method is not used any more.
##
##
## <#/GAPDoc>
##
DeclareOperation( "WeakPointerToExternalObject",
[ IsExternalConvexObjectRep ] );