AiHeuristicConst

java.lang.Object
- org.ai_heuristic.util.AiHeuristicConst

```
public class AiHeuristicConst
extends java.lang.Object
```
This class stores some constant values relating to the different types of heuristic or algorithm that are available.

Author:

Kieran Greer

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTIVATION`
`static java.lang.String`	`ADD` This defines the addition operator
`static java.lang.String`	`ALLMETRICS`
`static java.lang.String`	`BREADTH` This defines a tree breadth or branching factor for a search
`static java.lang.String`	`BS` The bucket size for tree container
`static java.lang.String`	`CFC` The constant factor c value
`static java.lang.String`	`CFIDFCOUNT`
`static java.lang.String`	`CITYBLOCKFUNCTION`
`static java.lang.String`	`COLINDEX` A column index indicator
`static java.lang.String`	`CONCEPTS` General terms
`static java.lang.String`	`CONDITION` Defines a condition description
`static java.lang.String`	`COSINEFUNCTION`
`static java.lang.String`	`COUNT` Defines a count field
`static java.lang.String`	`DEMERAULEVENSHTEIN`
`static java.lang.String`	`DEPTH` This defines a tree depth for a search
`static java.lang.String`	`DIMKEYS` This defines a ordered key list for a dimension node element
`static java.lang.String`	`DIMSIZE` This defines a dimension size node element
`static java.lang.String`	`DIVIDE` This defines the division operator
`static java.lang.String`	`DOTPRODUCT` This defines the dotproduct operator
`static java.lang.String`	`DUMMYKEY` This defines a dummy key that does not relate to any node
`static java.lang.String`	`EFC` The exponential factor c value
`static java.lang.String`	`EFN` The exponential factor n value
`static java.lang.String`	`EQ` This defines the equal to comparison
`static java.lang.String`	`EUCLIDEANFUNCTION`
`static java.lang.String`	`EVALUATOR`
`static java.lang.String`	`FUNCTION`
`static java.lang.String`	`FUNCTIONCONSTANT`
`static java.lang.String`	`FUNCTIONCOUNT`
`static java.lang.String`	`FUNCTIONEXPONENTIAL`
`static java.lang.String`	`FUNCTIONGAUSS`
`static java.lang.String`	`FUNCTIONHARDLIMIT`
`static java.lang.String`	`FUNCTIONHYPERBOLIC`
`static java.lang.String`	`FUNCTIONLINEAR`
`static java.lang.String`	`FUNCTIONLINEARPLUS`
`static java.lang.String`	`FUNCTIONLINEARRECTIFIED`
`static java.lang.String`	`FUNCTIONSIGMOID`
`static java.lang.String`	`FUNCTIONSYMMETRICHARDLIMIT`
`static java.lang.String`	`FUNCTIONTANH`
`static java.lang.String`	`GE` This defines the greater than or equal to comparison
`static java.lang.String`	`GFR` The gauss factor r (radius) value
`static java.lang.String`	`GT` This defines the greater than comparison
`static java.lang.String`	`HAMMING`
`static java.lang.String`	`HFC` The hyperbolic factor c value
`static java.lang.String`	`HFC2` The hyperbolic factor c2 value
`static java.lang.String`	`HLT` The hard limit t (threshold) value
`static java.lang.String`	`INDEXSIMILARITY`
`static java.lang.String`	`INFORMATIONGAIN`
`static java.lang.String`	`INTERSECTION` This defines the intersection operator
`static java.lang.String`	`JACCARDFUNCTION`
`static java.lang.String`	`JAROWINKLER`
`static java.lang.String`	`KDTREE` This defines a root kd-tree element
`static java.lang.String`	`KDTREENODE` This defines a kd-tree node element
`static java.lang.String`	`KEY` This defines a key node element
`static java.lang.String`	`KEYLIST` This defines a key list node element
`static java.lang.String`	`KNN` The number of neighbours value
`static java.lang.String`	`KULLBACKLEIBLER`
`static java.lang.String`	`LE` This defines the less than or equal to comparison
`static java.lang.String`	`LEVENSHTEIN`
`static java.lang.String`	`LPFA` The linear plus function a value
`static java.lang.String`	`LPFB` The linear plus function b value
`static java.lang.String`	`LT` This defines the less than comparison
`static java.lang.String`	`MAGNITUDE` This defines the magnitude operator
`static java.lang.String`	`MATHEVALUATOR`
`static java.lang.String`	`MAX` The maximum value
`static java.lang.String`	`MEDIAN` The median value
`static java.lang.String`	`METRIC`
`static java.lang.String`	`METRICDATASET` This defines a root metric dataset element
`static java.lang.String`	`METRICVALUE` This defines a root metric value element
`static java.lang.String`	`MIN` The minimum value
`static java.lang.String`	`MINKOWSKIFUNCTION`
`static java.lang.String`	`MKP` The minkowski distance power value
`static java.lang.String`	`MULTIPLY` This defines the multiplication operator
`static java.lang.String`	`NAME` Defines a name field
`static java.lang.String`	`NE` This defines the not equal to comparison
`static java.lang.String`	`NGN` The n (e.g.
`static java.lang.String`	`OPERATOR` Operator key type
`static java.lang.String`	`PARAMLIST` Defines a list of parameters element
`static java.lang.String`	`POWER` This defines the power operator
`static java.lang.String`	`PROBLEMS`
`static java.lang.String`	`REPLYSET` This defines a root reply set element
`static java.lang.String`	`ROWINDEX` A row index indicator
`static java.lang.String`	`SHLT` The symmetric hard limit t (threshold) value
`static java.lang.String`	`SIMPLEFUNCTION` Heuristic and function types
`static java.lang.String`	`SIMPLEMATHCOMPARE`
`static java.lang.String`	`STATS` The stats element type
`static java.lang.String`	`SUBTRACT` This defines the subtraction operator
`static java.lang.String`	`TREE` This defines a root tree element
`static java.lang.String`	`TREENODE` This defines a tree node element
`static java.lang.String`	`TYPE` Defines a type field
`static java.lang.String`	`UNION` This defines the union operator
`static java.lang.String`	`VALUE` Defines a value field
`static java.lang.String`	`VALUE1` Value 1 key type
`static java.lang.String`	`VALUE2` Value 2 key type
`static java.lang.String`	`VALUETYPE` Defines a value type field

Constructor Summary

Constructors
Constructor and Description

AiHeuristicConst()

Constructors
Constructor and Description
`AiHeuristicConst()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.ArrayList<java.lang.String>`	`activationFunctions()` Get a list of the default activation functions.
`static FactoryInfo`	`getAiFactoryInfo(java.lang.String heuristicType)` Get a factory info object for the specified heuristic or evaluator type.
`static java.lang.String`	`getAiFactoryKey(java.lang.String classType, java.util.HashMap<java.lang.String,FactoryInfo> factoryList)` Get the factory key value from the class type.
`static java.util.HashMap<java.lang.String,FactoryInfo>`	`getAiHeuristcTypes(java.lang.String heuristicType)` Get a list of available heuristic types.
`static java.util.ArrayList<java.lang.String>`	`learnFunctions()` Get a list of the default learn functions.
`boolean`	`simpleFunctionType(java.lang.String functionType)` Return true if the function type is a default simple type one.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONCEPTS
```
public static final java.lang.String CONCEPTS
```
    General terms
    
    See Also:
    
    Constant Field Values
  - PROBLEMS
```
public static final java.lang.String PROBLEMS
```
    See Also:
    
    Constant Field Values
  - FUNCTION
```
public static final java.lang.String FUNCTION
```
    See Also:
    
    Constant Field Values
  - EVALUATOR
```
public static final java.lang.String EVALUATOR
```
    See Also:
    
    Constant Field Values
  - ALLMETRICS
```
public static final java.lang.String ALLMETRICS
```
    See Also:
    
    Constant Field Values
  - METRIC
```
public static final java.lang.String METRIC
```
    See Also:
    
    Constant Field Values
  - ACTIVATION
```
public static final java.lang.String ACTIVATION
```
    See Also:
    
    Constant Field Values
  - MATHEVALUATOR
```
public static final java.lang.String MATHEVALUATOR
```
    See Also:
    
    Constant Field Values
  - SIMPLEFUNCTION
```
public static final java.lang.String SIMPLEFUNCTION
```
    Heuristic and function types
    
    See Also:
    
    Constant Field Values
  - EUCLIDEANFUNCTION
```
public static final java.lang.String EUCLIDEANFUNCTION
```
    See Also:
    
    Constant Field Values
  - CITYBLOCKFUNCTION
```
public static final java.lang.String CITYBLOCKFUNCTION
```
    See Also:
    
    Constant Field Values
  - MINKOWSKIFUNCTION
```
public static final java.lang.String MINKOWSKIFUNCTION
```
    See Also:
    
    Constant Field Values
  - COSINEFUNCTION
```
public static final java.lang.String COSINEFUNCTION
```
    See Also:
    
    Constant Field Values
  - JACCARDFUNCTION
```
public static final java.lang.String JACCARDFUNCTION
```
    See Also:
    
    Constant Field Values
  - KULLBACKLEIBLER
```
public static final java.lang.String KULLBACKLEIBLER
```
    See Also:
    
    Constant Field Values
  - INFORMATIONGAIN
```
public static final java.lang.String INFORMATIONGAIN
```
    See Also:
    
    Constant Field Values
  - CFIDFCOUNT
```
public static final java.lang.String CFIDFCOUNT
```
    See Also:
    
    Constant Field Values
  - SIMPLEMATHCOMPARE
```
public static final java.lang.String SIMPLEMATHCOMPARE
```
    See Also:
    
    Constant Field Values
  - LEVENSHTEIN
```
public static final java.lang.String LEVENSHTEIN
```
    See Also:
    
    Constant Field Values
  - DEMERAULEVENSHTEIN
```
public static final java.lang.String DEMERAULEVENSHTEIN
```
    See Also:
    
    Constant Field Values
  - HAMMING
```
public static final java.lang.String HAMMING
```
    See Also:
    
    Constant Field Values
  - INDEXSIMILARITY
```
public static final java.lang.String INDEXSIMILARITY
```
    See Also:
    
    Constant Field Values
  - JAROWINKLER
```
public static final java.lang.String JAROWINKLER
```
    See Also:
    
    Constant Field Values
  - FUNCTIONCONSTANT
```
public static final java.lang.String FUNCTIONCONSTANT
```
    See Also:
    
    Constant Field Values
  - FUNCTIONCOUNT
```
public static final java.lang.String FUNCTIONCOUNT
```
    See Also:
    
    Constant Field Values
  - FUNCTIONEXPONENTIAL
```
public static final java.lang.String FUNCTIONEXPONENTIAL
```
    See Also:
    
    Constant Field Values
  - FUNCTIONGAUSS
```
public static final java.lang.String FUNCTIONGAUSS
```
    See Also:
    
    Constant Field Values
  - FUNCTIONHYPERBOLIC
```
public static final java.lang.String FUNCTIONHYPERBOLIC
```
    See Also:
    
    Constant Field Values
  - FUNCTIONHARDLIMIT
```
public static final java.lang.String FUNCTIONHARDLIMIT
```
    See Also:
    
    Constant Field Values
  - FUNCTIONSYMMETRICHARDLIMIT
```
public static final java.lang.String FUNCTIONSYMMETRICHARDLIMIT
```
    See Also:
    
    Constant Field Values
  - FUNCTIONLINEAR
```
public static final java.lang.String FUNCTIONLINEAR
```
    See Also:
    
    Constant Field Values
  - FUNCTIONLINEARPLUS
```
public static final java.lang.String FUNCTIONLINEARPLUS
```
    See Also:
    
    Constant Field Values
  - FUNCTIONLINEARRECTIFIED
```
public static final java.lang.String FUNCTIONLINEARRECTIFIED
```
    See Also:
    
    Constant Field Values
  - FUNCTIONSIGMOID
```
public static final java.lang.String FUNCTIONSIGMOID
```
    See Also:
    
    Constant Field Values
  - FUNCTIONTANH
```
public static final java.lang.String FUNCTIONTANH
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    Defines a name field
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final java.lang.String TYPE
```
    Defines a type field
    
    See Also:
    
    Constant Field Values
  - VALUE
```
public static final java.lang.String VALUE
```
    Defines a value field
    
    See Also:
    
    Constant Field Values
  - VALUETYPE
```
public static final java.lang.String VALUETYPE
```
    Defines a value type field
    
    See Also:
    
    Constant Field Values
  - COUNT
```
public static final java.lang.String COUNT
```
    Defines a count field
    
    See Also:
    
    Constant Field Values
  - OPERATOR
```
public static final java.lang.String OPERATOR
```
    Operator key type
    
    See Also:
    
    Constant Field Values
  - VALUE1
```
public static final java.lang.String VALUE1
```
    Value 1 key type
    
    See Also:
    
    Constant Field Values
  - VALUE2
```
public static final java.lang.String VALUE2
```
    Value 2 key type
    
    See Also:
    
    Constant Field Values
  - CONDITION
```
public static final java.lang.String CONDITION
```
    Defines a condition description
    
    See Also:
    
    Constant Field Values
  - STATS
```
public static final java.lang.String STATS
```
    The stats element type
    
    See Also:
    
    Constant Field Values
  - ADD
```
public static final java.lang.String ADD
```
    This defines the addition operator
    
    See Also:
    
    Constant Field Values
  - SUBTRACT
```
public static final java.lang.String SUBTRACT
```
    This defines the subtraction operator
    
    See Also:
    
    Constant Field Values
  - MULTIPLY
```
public static final java.lang.String MULTIPLY
```
    This defines the multiplication operator
    
    See Also:
    
    Constant Field Values
  - DIVIDE
```
public static final java.lang.String DIVIDE
```
    This defines the division operator
    
    See Also:
    
    Constant Field Values
  - UNION
```
public static final java.lang.String UNION
```
    This defines the union operator
    
    See Also:
    
    Constant Field Values
  - INTERSECTION
```
public static final java.lang.String INTERSECTION
```
    This defines the intersection operator
    
    See Also:
    
    Constant Field Values
  - DOTPRODUCT
```
public static final java.lang.String DOTPRODUCT
```
    This defines the dotproduct operator
    
    See Also:
    
    Constant Field Values
  - MAGNITUDE
```
public static final java.lang.String MAGNITUDE
```
    This defines the magnitude operator
    
    See Also:
    
    Constant Field Values
  - POWER
```
public static final java.lang.String POWER
```
    This defines the power operator
    
    See Also:
    
    Constant Field Values
  - MAX
```
public static final java.lang.String MAX
```
    The maximum value
    
    See Also:
    
    Constant Field Values
  - MIN
```
public static final java.lang.String MIN
```
    The minimum value
    
    See Also:
    
    Constant Field Values
  - MEDIAN
```
public static final java.lang.String MEDIAN
```
    The median value
    
    See Also:
    
    Constant Field Values
  - BS
```
public static final java.lang.String BS
```
    The bucket size for tree container
    
    See Also:
    
    Constant Field Values
  - NGN
```
public static final java.lang.String NGN
```
    The n (e.g. n-gram length) value
    
    See Also:
    
    Constant Field Values
  - MKP
```
public static final java.lang.String MKP
```
    The minkowski distance power value
    
    See Also:
    
    Constant Field Values
  - EFN
```
public static final java.lang.String EFN
```
    The exponential factor n value
    
    See Also:
    
    Constant Field Values
  - HLT
```
public static final java.lang.String HLT
```
    The hard limit t (threshold) value
    
    See Also:
    
    Constant Field Values
  - SHLT
```
public static final java.lang.String SHLT
```
    The symmetric hard limit t (threshold) value
    
    See Also:
    
    Constant Field Values
  - GFR
```
public static final java.lang.String GFR
```
    The gauss factor r (radius) value
    
    See Also:
    
    Constant Field Values
  - LPFA
```
public static final java.lang.String LPFA
```
    The linear plus function a value
    
    See Also:
    
    Constant Field Values
  - LPFB
```
public static final java.lang.String LPFB
```
    The linear plus function b value
    
    See Also:
    
    Constant Field Values
  - CFC
```
public static final java.lang.String CFC
```
    The constant factor c value
    
    See Also:
    
    Constant Field Values
  - EFC
```
public static final java.lang.String EFC
```
    The exponential factor c value
    
    See Also:
    
    Constant Field Values
  - HFC
```
public static final java.lang.String HFC
```
    The hyperbolic factor c value
    
    See Also:
    
    Constant Field Values
  - HFC2
```
public static final java.lang.String HFC2
```
    The hyperbolic factor c2 value
    
    See Also:
    
    Constant Field Values
  - KNN
```
public static final java.lang.String KNN
```
    The number of neighbours value
    
    See Also:
    
    Constant Field Values
  - EQ
```
public static final java.lang.String EQ
```
    This defines the equal to comparison
    
    See Also:
    
    Constant Field Values
  - NE
```
public static final java.lang.String NE
```
    This defines the not equal to comparison
    
    See Also:
    
    Constant Field Values
  - GT
```
public static final java.lang.String GT
```
    This defines the greater than comparison
    
    See Also:
    
    Constant Field Values
  - GE
```
public static final java.lang.String GE
```
    This defines the greater than or equal to comparison
    
    See Also:
    
    Constant Field Values
  - LT
```
public static final java.lang.String LT
```
    This defines the less than comparison
    
    See Also:
    
    Constant Field Values
  - LE
```
public static final java.lang.String LE
```
    This defines the less than or equal to comparison
    
    See Also:
    
    Constant Field Values
  - METRICDATASET
```
public static final java.lang.String METRICDATASET
```
    This defines a root metric dataset element
    
    See Also:
    
    Constant Field Values
  - METRICVALUE
```
public static final java.lang.String METRICVALUE
```
    This defines a root metric value element
    
    See Also:
    
    Constant Field Values
  - REPLYSET
```
public static final java.lang.String REPLYSET
```
    This defines a root reply set element
    
    See Also:
    
    Constant Field Values
  - PARAMLIST
```
public static final java.lang.String PARAMLIST
```
    Defines a list of parameters element
    
    See Also:
    
    Constant Field Values
  - TREE
```
public static final java.lang.String TREE
```
    This defines a root tree element
    
    See Also:
    
    Constant Field Values
  - TREENODE
```
public static final java.lang.String TREENODE
```
    This defines a tree node element
    
    See Also:
    
    Constant Field Values
  - KDTREE
```
public static final java.lang.String KDTREE
```
    This defines a root kd-tree element
    
    See Also:
    
    Constant Field Values
  - KDTREENODE
```
public static final java.lang.String KDTREENODE
```
    This defines a kd-tree node element
    
    See Also:
    
    Constant Field Values
  - DIMSIZE
```
public static final java.lang.String DIMSIZE
```
    This defines a dimension size node element
    
    See Also:
    
    Constant Field Values
  - KEYLIST
```
public static final java.lang.String KEYLIST
```
    This defines a key list node element
    
    See Also:
    
    Constant Field Values
  - DIMKEYS
```
public static final java.lang.String DIMKEYS
```
    This defines a ordered key list for a dimension node element
    
    See Also:
    
    Constant Field Values
  - KEY
```
public static final java.lang.String KEY
```
    This defines a key node element
    
    See Also:
    
    Constant Field Values
  - DUMMYKEY
```
public static final java.lang.String DUMMYKEY
```
    This defines a dummy key that does not relate to any node
    
    See Also:
    
    Constant Field Values
  - DEPTH
```
public static final java.lang.String DEPTH
```
    This defines a tree depth for a search
    
    See Also:
    
    Constant Field Values
  - BREADTH
```
public static final java.lang.String BREADTH
```
    This defines a tree breadth or branching factor for a search
    
    See Also:
    
    Constant Field Values
  - COLINDEX
```
public static final java.lang.String COLINDEX
```
    A column index indicator
    
    See Also:
    
    Constant Field Values
  - ROWINDEX
```
public static final java.lang.String ROWINDEX
```
    A row index indicator
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AiHeuristicConst
```
public AiHeuristicConst()
```
- Method Detail
  - simpleFunctionType
```
public boolean simpleFunctionType(java.lang.String functionType)
```
    Return true if the function type is a default simple type one.
    
    Parameters:
    
    functionType - the type of function to use.
    
    Returns:
    
    true if a simple function.
  - getAiHeuristcTypes
```
public static java.util.HashMap<java.lang.String,FactoryInfo> getAiHeuristcTypes(java.lang.String heuristicType)
```
    Get a list of available heuristic types. This might not be a specific class, but a type of class.
    
    Parameters:
    
    heuristicType - the type of AI concept to return values for. Can be GENERIC, for example.
    
    Returns:
    
    a list of heuristic types. Key is the type identifier and value is a FactoryInfo object with related information.
  - getAiFactoryInfo
```
public static FactoryInfo getAiFactoryInfo(java.lang.String heuristicType)
```
    Get a factory info object for the specified heuristic or evaluator type.
    
    Parameters:
    
    heuristicType - the AI type to check for.
    
    Returns:
    
    a factory info object with related information.
  - getAiFactoryKey
```
public static java.lang.String getAiFactoryKey(java.lang.String classType,
                                               java.util.HashMap<java.lang.String,FactoryInfo> factoryList)
```
    Get the factory key value from the class type.
    
    Parameters:
    
    classType - the class type or name of the object.
    
    factoryList - the list of factory info objects to check over.
    
    Returns:
    
    the key name for the related object.
  - learnFunctions
```
public static java.util.ArrayList<java.lang.String> learnFunctions()
```
    Get a list of the default learn functions.
    
    Returns:
    
    a list of the default learn function types.
  - activationFunctions
```
public static java.util.ArrayList<java.lang.String> activationFunctions()
```
    Get a list of the default activation functions.
    
    Returns:
    
    a list of the default activation function types.

Class AiHeuristicConst

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONCEPTS

PROBLEMS

FUNCTION

EVALUATOR

ALLMETRICS

METRIC

ACTIVATION

MATHEVALUATOR

SIMPLEFUNCTION

EUCLIDEANFUNCTION

CITYBLOCKFUNCTION

MINKOWSKIFUNCTION

COSINEFUNCTION

JACCARDFUNCTION

KULLBACKLEIBLER

INFORMATIONGAIN

CFIDFCOUNT

SIMPLEMATHCOMPARE

LEVENSHTEIN

DEMERAULEVENSHTEIN

HAMMING

INDEXSIMILARITY

JAROWINKLER

FUNCTIONCONSTANT

FUNCTIONCOUNT

FUNCTIONEXPONENTIAL

FUNCTIONGAUSS

FUNCTIONHYPERBOLIC

FUNCTIONHARDLIMIT

FUNCTIONSYMMETRICHARDLIMIT

FUNCTIONLINEAR

FUNCTIONLINEARPLUS

FUNCTIONLINEARRECTIFIED

FUNCTIONSIGMOID

FUNCTIONTANH

NAME

TYPE

VALUE

VALUETYPE

COUNT

OPERATOR

VALUE1

VALUE2

CONDITION

STATS

ADD

SUBTRACT

MULTIPLY

DIVIDE

UNION

INTERSECTION

DOTPRODUCT

MAGNITUDE

POWER

MAX

MIN

MEDIAN

BS

NGN

MKP

EFN

HLT

SHLT

GFR

LPFA

LPFB

CFC

EFC

HFC

HFC2

KNN

EQ

NE

GT