removed more useless getter descriptions

This commit is contained in:
Robin 2021-10-12 04:08:32 +02:00
parent b80e170006
commit cfb27e3de3
17 changed files with 7 additions and 63 deletions

View File

@ -32,8 +32,6 @@ public class Conclusion {
} }
/** /**
* Returns the type assumptions used in the conclusion.
*
* @return the type assumptions used in the conclusion * @return the type assumptions used in the conclusion
*/ */
public Map<VarTerm, TypeAbstraction> getTypeAssumptions() { public Map<VarTerm, TypeAbstraction> getTypeAssumptions() {
@ -41,8 +39,6 @@ public class Conclusion {
} }
/** /**
* Returns the lambda term in the conclusion.
*
* @return the lambda term in the conclusion * @return the lambda term in the conclusion
*/ */
public LambdaTerm getLambdaTerm() { public LambdaTerm getLambdaTerm() {
@ -50,8 +46,6 @@ public class Conclusion {
} }
/** /**
* Returns the type assigned to the lambda term in the conclusion.
*
* @return the type assigned to the lambda term in the conclusion * @return the type assigned to the lambda term in the conclusion
*/ */
public Type getType() { public Type getType() {

View File

@ -26,8 +26,6 @@ public class Substitution {
} }
/** /**
* Returns the type variable
*
* @return the type variable * @return the type variable
*/ */
public TypeVariable getVariable() { public TypeVariable getVariable() {
@ -35,8 +33,6 @@ public class Substitution {
} }
/** /**
* Returns the replacement type
*
* @return the replacement type * @return the replacement type
*/ */
public Type getType() { public Type getType() {

View File

@ -81,19 +81,15 @@ public class Tree implements TermVisitorTree {
} }
/** /**
* Returns the first type variable the original lambda term was assigned in the first inference step. * @return the first type variable the original lambda term was assigned in the first inference step
*
* @return the first type variable
*/ */
protected TypeVariable getFirstTypeVariable() { protected TypeVariable getFirstTypeVariable() {
return firstTypeVariable; return firstTypeVariable;
} }
/** /**
* Returns the list of constraints that formed while generating the inference step tree * @return the list of constraints that formed while generating the inference step tree
* structure, needed for the subsequent unification. * * structure, needed for the subsequent unification
*
* @return the constraint list of the tree
*/ */
protected List<Constraint> getConstraints() { protected List<Constraint> getConstraints() {
return constraints; return constraints;

View File

@ -29,8 +29,6 @@ public class AbsTerm extends LambdaTerm {
} }
/** /**
* Returns the variable of this abstraction
*
* @return the variable of this abstraction * @return the variable of this abstraction
*/ */
public VarTerm getVariable() { public VarTerm getVariable() {
@ -38,8 +36,6 @@ public class AbsTerm extends LambdaTerm {
} }
/** /**
* Returns the function body of this abstraction
*
* @return the function body of this abstraction * @return the function body of this abstraction
*/ */
public LambdaTerm getInner() { public LambdaTerm getInner() {

View File

@ -25,8 +25,6 @@ public class AppTerm extends LambdaTerm {
} }
/** /**
* Returns the function used in this application
*
* @return the function used in this application * @return the function used in this application
*/ */
public LambdaTerm getFunction() { public LambdaTerm getFunction() {
@ -34,8 +32,6 @@ public class AppTerm extends LambdaTerm {
} }
/** /**
* Returns the parameter used in this application
*
* @return the parameter used in this application * @return the parameter used in this application
*/ */
public LambdaTerm getParameter() { public LambdaTerm getParameter() {

View File

@ -20,8 +20,6 @@ public class BooleanTerm extends ConstTerm {
} }
/** /**
* Returns the value of the boolean constant term.
*
* @return the value of the term * @return the value of the term
*/ */
public boolean getValue() { public boolean getValue() {

View File

@ -15,8 +15,6 @@ import java.util.Set;
public abstract class ConstTerm extends LambdaTerm { public abstract class ConstTerm extends LambdaTerm {
/** /**
* Returns the named type of the constant
*
* @return the named type of the constant * @return the named type of the constant
*/ */
public abstract NamedType getType(); public abstract NamedType getType();

View File

@ -20,8 +20,6 @@ public class IntegerTerm extends ConstTerm {
} }
/** /**
* Returns the value of the integer constant term.
*
* @return the value of the term * @return the value of the term
*/ */
public int getValue() { public int getValue() {

View File

@ -14,16 +14,12 @@ import java.util.Set;
*/ */
public abstract class LambdaTerm { public abstract class LambdaTerm {
/** /**
* Returns whether the lambda term contains a let expression
*
* @return whether the lambda term contains a let expression * @return whether the lambda term contains a let expression
*/ */
public abstract boolean hasLet(); public abstract boolean hasLet();
/** /**
* Returns a set of all free variables occurring in the lambda term. * @return a set of all free variables occurring in the lambda term
*
* @return all free variables
*/ */
public abstract Set<VarTerm> getFreeVariables(); public abstract Set<VarTerm> getFreeVariables();

View File

@ -24,8 +24,6 @@ public class VarTerm extends LambdaTerm {
} }
/** /**
* Returns the name of this variable
*
* @return the name of this variable * @return the name of this variable
*/ */
public String getName() { public String getName() {

View File

@ -117,8 +117,6 @@ public class FunctionType extends Type {
} }
/** /**
* Getter for output
*
* @return output * @return output
*/ */
public Type getOutput() { public Type getOutput() {
@ -126,8 +124,6 @@ public class FunctionType extends Type {
} }
/** /**
* Getter for parameter
*
* @return parameter * @return parameter
*/ */
public Type getParameter() { public Type getParameter() {

View File

@ -32,8 +32,6 @@ public class NamedType extends Type {
} }
/** /**
* Returns the name of the named type.
*
* @return the name of this type * @return the name of this type
*/ */
public String getName() { public String getName() {

View File

@ -19,9 +19,7 @@ public abstract class Type {
public abstract boolean contains(Type x); public abstract boolean contains(Type x);
/** /**
* Returns a set of all free type variables occurring in the type. * @return a set of all free type variables occurring in the type
*
* @return all free type variables
*/ */
public abstract Set<TypeVariable> getFreeTypeVariables(); public abstract Set<TypeVariable> getFreeTypeVariables();

View File

@ -87,9 +87,7 @@ public class TypeAbstraction {
} }
/** /**
* Returns a set of all free type variables occurring in the type abstraction. * @return a set of all free type variables occurring in the type abstraction
*
* @return all free type variables
*/ */
public Set<TypeVariable> getFreeTypeVariables() { public Set<TypeVariable> getFreeTypeVariables() {
Set<TypeVariable> set = new HashSet<>(this.type.getFreeTypeVariables()); Set<TypeVariable> set = new HashSet<>(this.type.getFreeTypeVariables());
@ -98,8 +96,6 @@ public class TypeAbstraction {
} }
/** /**
* Getter for the inner type of the type abstraction
*
* @return the inner type of the type abstraction * @return the inner type of the type abstraction
*/ */
public Type getInnerType() { public Type getInnerType() {

View File

@ -30,8 +30,6 @@ public class TypeVariable extends Type implements Comparable<TypeVariable> {
} }
/** /**
* Returns the kind of the type variable.
*
* @return the variable's kind * @return the variable's kind
*/ */
public TypeVariableKind getKind() { public TypeVariableKind getKind() {
@ -39,8 +37,6 @@ public class TypeVariable extends Type implements Comparable<TypeVariable> {
} }
/** /**
* Returns the index of the type variable as an integer
*
* @return the variable's index * @return the variable's index
*/ */
public int getIndex() { public int getIndex() {

View File

@ -34,8 +34,6 @@ public class UnificationActions {
} }
/** /**
* Getter for constraints
*
* @return the constraints stored in this object * @return the constraints stored in this object
*/ */
public Collection<Constraint> getConstraints() { public Collection<Constraint> getConstraints() {
@ -43,8 +41,6 @@ public class UnificationActions {
} }
/** /**
* Getter for substitution
*
* @return the substitution stored in this object * @return the substitution stored in this object
*/ */
public Optional<Substitution> getSubstitution() { public Optional<Substitution> getSubstitution() {

View File

@ -70,9 +70,7 @@ public class ExplanationCreator implements StepVisitor {
} }
/** /**
* Returns a list of strings with an entry for every step of the algorithm. * @return list of strings with an entry for every step of the algorithm.
*
* @return list of strings containing the explanatory texts
*/ */
public List<String> getExplanationTexts() { public List<String> getExplanationTexts() {
return explanationTexts; return explanationTexts;