 | Report generated by Clover Code Coverage v2.3.1 Sat Sep 18 2010 04:09:52 UTC. |
Clover: Open Source License registered to qedeq.org . |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FunctionDefinition | Line # 26 | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| No Tests | |||
| 1 | /* This file is part of the project "Hilbert II" - http://www.qedeq.org | |
| 2 | * | |
| 3 | * Copyright 2000-2010, Michael Meyling <mime@qedeq.org>. | |
| 4 | * | |
| 5 | * "Hilbert II" is free software; you can redistribute | |
| 6 | * it and/or modify it under the terms of the GNU General Public | |
| 7 | * License as published by the Free Software Foundation; either | |
| 8 | * version 2 of the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This program is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 | * GNU General Public License for more details. | |
| 14 | */ | |
| 15 | ||
| 16 | package org.qedeq.kernel.base.module; | |
| 17 | ||
| 18 | ||
| 19 | /** | |
| 20 | * Definition of function operator. This is a function constant. For example the function | |
| 21 | * "x union y" or constants like the empty set. | |
| 22 | * | |
| 23 | * @version $Revision: 1.4 $ | |
| 24 | * @author Michael Meyling | |
| 25 | */ | |
| 26 | public interface FunctionDefinition extends NodeType { | |
| 27 | ||
| 28 | /** | |
| 29 | * Get number of arguments for the defined object. Carries information about the argument | |
| 30 | * number the defined object needs. | |
| 31 | * | |
| 32 | * @return Argument number. | |
| 33 | */ | |
| 34 | public String getArgumentNumber(); | |
| 35 | ||
| 36 | /** | |
| 37 | * This name together with {@link #getArgumentNumber()} identifies a function. | |
| 38 | * | |
| 39 | * @return Name of defined function. | |
| 40 | */ | |
| 41 | public String getName(); | |
| 42 | ||
| 43 | /** | |
| 44 | * Get LaTeX output for definition. The replaceable arguments must are marked as "#1", | |
| 45 | * "#2" and so on. For example "\mathfrak{M}(#1)" | |
| 46 | * | |
| 47 | * @return LaTeX pattern for definition type setting. | |
| 48 | */ | |
| 49 | public String getLatexPattern(); | |
| 50 | ||
| 51 | /** | |
| 52 | * Get variable list of definition arguments. | |
| 53 | * | |
| 54 | * @return List of formulas or subject variables to be replaced in the LaTeX pattern. | |
| 55 | * Could be <code>null</code>. | |
| 56 | */ | |
| 57 | public VariableList getVariableList(); | |
| 58 | ||
| 59 | /** | |
| 60 | * Get term that defines the object. Could be <code>null</code>. | |
| 61 | * | |
| 62 | * @return Defining term. | |
| 63 | */ | |
| 64 | public Term getTerm(); | |
| 65 | ||
| 66 | /** | |
| 67 | * Get description. Only necessary if formula is not self-explanatory. | |
| 68 | * | |
| 69 | * @return Description. | |
| 70 | */ | |
| 71 | public LatexList getDescription(); | |
| 72 | ||
| 73 | } | |
|
||||||||||