ai.libs.jaicore.basic.algorithm

Interface IAlgorithmConfig

All Superinterfaces:

org.aeonbits.owner.Config, org.aeonbits.owner.Mutable, java.io.Serializable

public interface IAlgorithmConfig
extends org.aeonbits.owner.Mutable

Nested Class Summary

Nested classes/interfaces inherited from interface org.aeonbits.owner.Config

org.aeonbits.owner.Config.ConverterClass, org.aeonbits.owner.Config.DecryptorClass, org.aeonbits.owner.Config.DefaultValue, org.aeonbits.owner.Config.DisableableFeature, org.aeonbits.owner.Config.DisableFeature, org.aeonbits.owner.Config.EncryptedValue, org.aeonbits.owner.Config.HotReload, org.aeonbits.owner.Config.HotReloadType, org.aeonbits.owner.Config.Key, org.aeonbits.owner.Config.LoadPolicy, org.aeonbits.owner.Config.LoadType, org.aeonbits.owner.Config.PreprocessorClasses, org.aeonbits.owner.Config.Separator, org.aeonbits.owner.Config.Sources, org.aeonbits.owner.Config.TokenizerClass

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	K_CPUS
static java.lang.String	K_MEMORY
static java.lang.String	K_THREADS
static java.lang.String	K_TIMEOUT

Method Summary

Modifier and Type	Method and Description
int	cpus()
default IAlgorithmConfig	loadPropertiesFromFile(java.io.File file) Reads properties of a config from a config file.
default IAlgorithmConfig	loadPropertiesFromList(java.util.List<java.lang.String> propertiesList) Loads a properties config from a list of property assignments.
default IAlgorithmConfig	loadPropertiesFromResource(java.lang.String resourcePath) Loads properties from a resource (instead of a file).
int	memory()
int	threads()
long	timeout()

Methods inherited from interface org.aeonbits.owner.Mutable

addPropertyChangeListener, addPropertyChangeListener, clear, load, load, removeProperty, removePropertyChangeListener, setProperty

Field Detail

K_CPUS

static final java.lang.String K_CPUS

See Also:

Constant Field Values

K_THREADS

static final java.lang.String K_THREADS

See Also:

Constant Field Values

K_MEMORY

static final java.lang.String K_MEMORY

See Also:

Constant Field Values

K_TIMEOUT

static final java.lang.String K_TIMEOUT

See Also:

Constant Field Values

Method Detail

cpus

@Config.Key(value="cpus")
 @Config.DefaultValue(value="8")
int cpus()

Returns:

Number of CPU cores available for parallelization.

threads

@Config.Key(value="threads")
 @Config.DefaultValue(value="-1")
int threads()

Returns:

Number of threads that may be spawned by the algorithm. If set to -1, the number of CPUs is used as the number of threads. If set to 0, parallelization is deactivated.

memory

@Config.Key(value="memory")
 @Config.DefaultValue(value="256")
int memory()

Returns:

The main memory that is available to be used. This is merely a documentation variable since the true memory must be set over the JVM initialization anyway and cannot be restricted inside of it.

timeout

@Config.Key(value="timeout")
 @Config.DefaultValue(value="-1")
long timeout()

Returns:

Overall timeout for the algorithm in milliseconds.

loadPropertiesFromFile

default IAlgorithmConfig loadPropertiesFromFile(java.io.File file)

Reads properties of a config from a config file.

Parameters:

file - The file to read in as properties.

Throws:

java.io.IOException - Throws an IOException if an issue occurs while reading in the properties from the given file.

loadPropertiesFromResource

default IAlgorithmConfig loadPropertiesFromResource(java.lang.String resourcePath)
                                             throws java.io.IOException

Loads properties from a resource (instead of a file).

Parameters:

resourcePath - The path to the resource.

Throws:

java.io.IOException - Throws an IOException if an issue occurs while reading in the properties from the given resource.

loadPropertiesFromList

default IAlgorithmConfig loadPropertiesFromList(java.util.List<java.lang.String> propertiesList)

Loads a properties config from a list of property assignments.

Parameters:

propertiesList - The list of property assignments.