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