<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>ConvexInterface -- Interface to the Maple package Convex.</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_call__Convex.html">next</a> | previous | <a href="_call__Convex.html">forward</a> | backward | up | top | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<hr/>
<div><h1>ConvexInterface -- Interface to the Maple package Convex.</h1>
<div class="single"><h2>Description</h2>
<div><p><b>What’s new:</b></p>
<p><i>October 4, 2009:</i> Added a generic function <a href="_call__Convex.html" title="Generic function to run a Convex program.">callConvex</a> taking a string with a program written in Convex syntax.</p>
<p><i>September 20, 2009:</i> Added functions <a href="_m__Pos__Hull__Faces.html" title="Faces of a positive hull.">mPosHullFaces</a> and <a href="_m__Pos__Hull__Faces__And__Duals.html" title="Faces and their duals of positive hull.">mPosHullFacesAndDuals</a> to compute the face complex of a cone. They have an <a href="../../Macaulay2Doc/html/___Option.html" title="the class of all pairs x => y">Option</a> <a href="_to__File.html" title="Store result in a file.">toFile</a> to store the result of a computation in a file, and a function <a href="_read__Pos__Hull__Faces.html" title="Read the result of a previous mPosHullFaces or mPosHullFacesAndDuals computation.">readPosHullFaces</a> to read the file.</p>
<p><i>September 10, 2009:</i> Added a function <a href="_m__Lattice__Points.html" title="Compute the lattice points of a convex hull.">mLatticePoints</a> to compute the lattice points of polytope.</p>
<p><i>August 28, 2009:</i> The interface now uses indexed vertices. This substantially improves computation time and memory usage.</p>
<p><i>August 25, 2009:</i> Added an <a href="../../Macaulay2Doc/html/___Option.html" title="the class of all pairs x => y">Option</a> <a href="_to__File.html" title="Store result in a file.">toFile</a> to <a href="_m__Convex__Hull__Faces.html" title="Faces of a convex hull.">mConvexHullFaces</a> and <a href="_m__Convex__Hull__Faces__And__Duals.html" title="Faces and their duals of a convex hull.">mConvexHullFacesAndDuals</a> to store the result of a computation in a file, and a function <a href="_read__Convex__Hull__Faces.html" title="Read the result of a previous mConvexHullFaces or mConvexHullFacesAndDuals computation.">readConvexHullFaces</a> to read the file.</p>
<p><b>Overview:</b></p>
<p>The goal of this package is to provide the functions of the Maple package Convex in <i>Macaulay2</i>.</p>
<p>The Convex package is distributed by Matthias Franz under the GNU General Public License, see</p>
<p><a href="http://www.math.uwo.ca/~mfranz/convex">http://www.math.uwo.ca/~mfranz/convex</a></p>
<p>for more information.</p>
<p>ConvexInterface is work in progress and so far accesses only a fraction of the functionality provided by Convex. If you would like to help to expand this you are welcome.</p>
<p>Note that there is a generic function <a href="_call__Convex.html" title="Generic function to run a Convex program.">callConvex</a> with takes a String containing a program written in the Syntax of Maple/Convex.</p>
<p><b>Functions:</b></p>
<p>So far the following functions are accessible via ConvexInterface:</p>
<p><a href="_m__Convex__Hull__Faces.html" title="Faces of a convex hull.">mConvexHullFaces</a> -- compute the faces of a convex hull</p>
<p><a href="_m__Convex__Hull__Faces__And__Duals.html" title="Faces and their duals of a convex hull.">mConvexHullFacesAndDuals</a> -- computing the faces and their duals</p>
<p><a href="_m__Homology.html" title="Compute the homology.">mHomology</a> -- Compute the homology of a (not necessarily simplicial) complex</p>
<p><a href="_m__Lattice__Points.html" title="Compute the lattice points of a convex hull.">mLatticePoints</a> -- computing the lattice points of a convex hull</p>
<p><a href="_m__Pos__Hull__Faces.html" title="Faces of a positive hull.">mPosHullFaces</a> -- compute the faces of a positive hull</p>
<p><a href="_m__Pos__Hull__Faces__And__Duals.html" title="Faces and their duals of positive hull.">mPosHullFacesAndDuals</a> -- computing the faces and their duals of a positive hull</p>
<p></p>
<p>Other functions that may be interesting to access:</p>
<p>dual, hilbertbasis, simplicialsubdiv, minkowskisum, newtonpolytope</p>
<p>and also</p>
<p>affinehull, ambientdim, arecompatible, boundary, codim, contains, containsrelint, convhull, corank, corners, crosspolytope, cube, cyclicpolytope, delaunay, dim, directsum, distance, domain, dotprod, draw, dual, edges, emptypcomplex, emptypolyhedron, emptypolytope, facefan, faces, facets, fan, flagf, flagh, fullcone, fullpolyhedron, furthestdelaunay, fvector, genhpolynomial, genhvector, hilbertbasis, homology, hplanes, hspacenos, hspaces, hvector, image, incidencematrix, incidentfacets, incidentrays, intersection, isaffine, isbounded, iscomplete, iscontained, isempty, isface, isfulldim, islinear, ispointed, ispolytopal, isquasipolytopal, isregular, issimple, issimplex, issimplicial, issimplicial1, join, lensspace, lineality, linearhull, lines, maximal, maximum, minimal, minimum, minkowskisum, modz, newtonpolytope, normalfan, pcomplex, permutahedron, plotdata, polar, poshull, posorthant, pred, preimage, projspace, proximum, randompolytope, rank, raynos, rays, readpoly, recession, regularpart, regularsubdiv, relint, simplicialsubdiv, skeleton, stdsimplex, stellarsubdiv, succ, support, surface, torsion, transversalfan, traverse, traverse2, vertexnos, vertices, volume, voronoi, wprojspace, writepoly, zerocone, zerofan</p>
<p><b>Setup:</b></p>
<p>This package needs the package <a href="../../MapleInterface/html/index.html" title="Interface to Maple.">MapleInterface</a>, so set this up first.</p>
<p>Install the convex package in Maple, i.e., put the file</p>
<p><a href="http://www.math.uwo.ca/~mfranz/convex/files/current/convex.m">http://www.math.uwo.ca/~mfranz/convex/files/current/convex.m</a></p>
<p>into the lib directory inside your Maple program directory. You can test it in Maple by typing <i>with(convex);</i></p>
<p>Install the <i>ConvexInterface</i> package in M2 by typing</p>
<p>installPackage("ConvexInterface")</p>
<p></p>
<p><b>Additional remarks:</b></p>
<p>You can put the convex.m file in any directory which shows up when you type in Maple</p>
<p>libname;</p>
<p>You can change this global variable by editing the Maple init file.</p>
<p>You can also put the convex.m file in any directory you want, as long as you tell M2 about the path. In this case the installation goes as follows: Do</p>
<p>installPackage("MapleInterface")</p>
<p>Edit the file init-MapleInterface.m2 in the directory .Macaulay2 in your home directory changing the line</p>
<p>"ConvexPath" =""</p>
<p>to</p>
<p>"ConvexPath" =StringWithPathToConvex</p>
<p>where StringWithPathToConvex is a string containing the path to the directory containing the convex.m file.</p>
<p>In Unix type systems this will be something like</p>
<p>"/home/boehm/convex"</p>
<p>In Windows systems use double backslashes to separate directories and the triple-slash as string delimiter. See the beginning of the source code for an example.</p>
<p></p>
<p>To test whether the interface is set up properly do, e.g.,</p>
<p>callConvex("returnvalue:=convert(fvector(convhull([1,0],[0,1],[-1,0],[0,-1])),list);")</p>
<p>which should return {1,4,4,1}.</p>
<div/>
</div>
</div>
<div class="single"><h2>Author</h2>
<ul><li><div class="single"><a href="http://www.math.uni-sb.de/ag/schreyer/jb/">Janko Boehm</a><span> <<a href="mailto:boehm@math.uni-sb.de">boehm@math.uni-sb.de</a>></span></div>
</li>
</ul>
</div>
<div class="single"><h2>Version</h2>
This documentation describes version <b>0.32</b> of ConvexInterface.</div>
<div class="single"><h2>Source code</h2>
The source code from which this documentation is derived is in the file <a href="../../../../Macaulay2/ConvexInterface.m2">ConvexInterface.m2</a>. The auxiliary files accompanying it are in the directory <a href="../../../../Macaulay2/ConvexInterface/">ConvexInterface/</a>.</div>
<div class="single"><h2>Exports</h2>
<ul><li><div class="single">Types<ul><li><span><a href="___Finitely__Generated__Abelian__Group.html" title="Class of finitely generated abelian groups.">FinitelyGeneratedAbelianGroup</a> -- Class of finitely generated abelian groups.</span></li>
</ul>
</div>
</li>
<li><div class="single">Functions<ul><li><span><a href="_call__Convex.html" title="Generic function to run a Convex program.">callConvex</a> -- Generic function to run a Convex program.</span></li>
<li><span><a href="_m__Convex__Hull__Faces.html" title="Faces of a convex hull.">mConvexHullFaces</a> -- Faces of a convex hull.</span></li>
<li><span><a href="_m__Convex__Hull__Faces__And__Duals.html" title="Faces and their duals of a convex hull.">mConvexHullFacesAndDuals</a> -- Faces and their duals of a convex hull.</span></li>
<li><span><a href="_m__Homology.html" title="Compute the homology.">mHomology</a> -- Compute the homology.</span></li>
<li><span><a href="_m__Lattice__Points.html" title="Compute the lattice points of a convex hull.">mLatticePoints</a> -- Compute the lattice points of a convex hull.</span></li>
<li><span><a href="_m__Pos__Hull__Faces.html" title="Faces of a positive hull.">mPosHullFaces</a> -- Faces of a positive hull.</span></li>
<li><span><a href="_m__Pos__Hull__Faces__And__Duals.html" title="Faces and their duals of positive hull.">mPosHullFacesAndDuals</a> -- Faces and their duals of positive hull.</span></li>
<li><span><a href="_read__Convex__Hull__Faces.html" title="Read the result of a previous mConvexHullFaces or mConvexHullFacesAndDuals computation.">readConvexHullFaces</a> -- Read the result of a previous mConvexHullFaces or mConvexHullFacesAndDuals computation.</span></li>
<li><span><a href="_read__Pos__Hull__Faces.html" title="Read the result of a previous mPosHullFaces or mPosHullFacesAndDuals computation.">readPosHullFaces</a> -- Read the result of a previous mPosHullFaces or mPosHullFacesAndDuals computation.</span></li>
</ul>
</div>
</li>
<li><div class="single">Symbols<ul><li><span><a href="_to__File.html" title="Store result in a file.">toFile</a> -- Store result in a file.</span></li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</body>
</html>
