1 /*
2 	This program is free software; you can redistribute it and/or
3 	modify it under the terms of the GNU General Public License
4 	as published by the Free Software Foundation; either version 2
5 	of the License, or (at your option) any later version.
6 
7 	This program is distributed in the hope that it will be useful,
8 	but WITHOUT ANY WARRANTY; without even the implied warranty of
9 	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10 	GNU General Public License for more details.
11 
12 	You should have received a copy of the GNU General Public License
13 	along with this program; if not, write to the Free Software
14 	Foundation, Inc., 51 Franklin Street, Fifth Floor,
15 	Boston, MA  02110-1301, USA.
16 
17 	---
18 	Copyright (C) 2011 - 2015, Simon Hampe <simon.hampe@googlemail.com>
19 
20 	---
21 	Copyright (c) 2016-2021
22 	Ewgenij Gawrilow, Michael Joswig, and the polymake team
23 	Technische Universität Berlin, Germany
24 	https://polymake.org
25 
26 	Implements skeleton.h
27 	*/
28 
29 #include "polymake/tropical/skeleton.h"
30 
31 namespace polymake { namespace tropical {
32 
33 	UserFunctionTemplate4perl("# @category Basic polyhedral operations"
34 			"# Takes a polyhedral complex and computes the k-skeleton. Will return an empty cycle, "
35 			"# if k is larger then the dimension of the given complex or smaller than 0."
36 			"# @param Cycle<Addition> C A polyhedral complex."
37 			"# @param Int k The dimension of the skeleton that should be computed"
38 			"# @param Bool preserveRays When true, the function assumes that all rays of the fan remain"
39 			"# in the k-skeleton, so it just copies the VERTICES, instead of computing an irredundant list."
40 			"# By default, this property is false."
41 			"# @return Cycle<Addition> The k-skeleton (without any weights, except if k is the dimension of C",
42 			"skeleton_complex<Addition>(Cycle<Addition>, $;$=0)");
43 }}
44