Index (api 1.0.35 API)

A B C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

actorHiddenLayerCount() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Number of hidden layers in the Actor network.
actorHiddenLayerCount() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the number of hidden layers in the Actor network.
actorHiddenLayerCount(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
actorHiddenLayerCount(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
actorHiddenLayerCount(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
actorHiddenLayerNeuronCount() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the number of neurons in each hidden layer of the Actor network.
actorHiddenLayerNeuronCount(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
actorHiddenLayerNeuronCount(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
actorHiddenNeuronCount() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Neurons per hidden layer in the Actor (policy) network.
actorHiddenNeuronCount(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
add(double) - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement: Appends a single value to the element.
add(double, double, double) - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement: Appends a 3D vector to the element.
addAgent(String, ConfigType) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Adds a new agent to the group.
addElement(SpartanContextElement, int) - Method in interface org.spartan.api.engine.context.SpartanContext: Registers a new "Sense" or input source.
alphaLearningRate() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the learning rate for the alpha (entropy temperature) learner.
alphaLearningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
alphaLearningRate(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
applyReward(double) - Method in interface org.spartan.api.engine.SpartanAgent: Applies a reward signal to this agent without triggering a tick.
applyRewards(double[]) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Manually applies rewards to all agents.
AUTO_ENCODER_COMPRESSOR - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: AutoEncoder Compressor model.
AutoEncoderCompressorConfig - Interface in org.spartan.api.engine.config: Configuration for the AutoEncoder Compressor model.
AutoEncoderCompressorConfig.Builder - Class in org.spartan.api.engine.config
AutoEncoderCompressorModel - Interface in org.spartan.api.engine.model: A passive utility model for dimension reduction via learned compression.
award() - Method in interface org.spartan.api.engine.action.type.SpartanAction: Calculates the reward for this specific action based on its recent performance.

B

bottleneckRegularisationWeight() - Method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig: Returns the weight of the regularization term.
bottleneckRegularisationWeight(double) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
build() - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
build() - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
build() - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
build() - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
build() - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
build() - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
build(SpartanApi, String, AutoEncoderCompressorConfig, SpartanContext, SpartanActionManager) - Static method in interface org.spartan.api.engine.model.AutoEncoderCompressorModel: Helper to build this specific model type.
build(SpartanApi, String, CuriosityDrivenRecurrentSoftActorCriticConfig, SpartanContext, SpartanActionManager) - Static method in interface org.spartan.api.engine.model.CuriosityDrivenRecurrentSoftActorCriticModel: Helper to build this specific model type.
build(SpartanApi, String, DoubleDeepQNetworkConfig, SpartanContext, SpartanActionManager) - Static method in interface org.spartan.api.engine.model.DoubleDeepQNetworkModel: Helper to build this specific model type.
build(SpartanApi, String, ProximalPolicyOptimizationConfig, SpartanContext, SpartanActionManager) - Static method in interface org.spartan.api.engine.model.ProximalPolicyOptimizationModel: Helper to build the PPO model via the Spartan API.
build(SpartanApi, String, RecurrentSoftActorCriticConfig, SpartanContext, SpartanActionManager) - Static method in interface org.spartan.api.engine.model.RecurrentSoftActorCriticModel: Helper to build this specific model type.
build(SpartanApi, String) - Static method in interface org.spartan.api.engine.context.SpartanContext: Creates a new Context via the API.
builder() - Static method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig
builder() - Static method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
builder() - Static method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig
builder() - Static method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig
builder() - Static method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
builder() - Static method in interface org.spartan.api.engine.config.SpartanMultiAgentGroupConfig
Builder() - Constructor for class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
Builder() - Constructor for class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
Builder() - Constructor for class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
BYTE_SIZE - Static variable in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Size in bytes of this struct in native memory (4 × int32_t = 16 bytes).
byteOffset() - Method in record class org.spartan.api.engine.context.ValueRange: Returns the byte offset for this range's start (multiplied by sizeof(double) = 8).

C

clear() - Method in class org.spartan.api.engine.context.element.hot.SpartanHotContextElement: Clears the backing array to zeros.
clipRange() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: PPO clipping range (epsilon in the paper).
clipRange(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
close() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Cleans up resources associated with this element.
close() - Method in interface org.spartan.api.engine.SpartanModel: Unregisters from C++ and releases resources.
close() - Method in interface org.spartan.api.SpartanApi: Closes the API and frees all associated native memory (Contexts, Models, Buffers).
CompressedVariableContextElement - Class in org.spartan.api.engine.context.element.compressed: A VariableContextElement that wraps a compressor model internally.
CompressedVariableContextElement(SpartanVariableContextElement, AutoEncoderCompressorConfig, SpartanApi) - Constructor for class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Constructs the compressed element - SELF-CONTAINED.
containsPhysicalIndex(int) - Method in record class org.spartan.api.engine.context.ValueRange: Checks if a given physical index falls within this range's allocation.
contextSliceElementCount() - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Returns the value of the contextSliceElementCount record component.
contextSliceStartIndex() - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Returns the value of the contextSliceStartIndex record component.
copy(String) - Method in interface org.spartan.api.engine.SpartanModel: Creates a deep copy of this model with a new identifier.
create() - Static method in interface org.spartan.api.SpartanApi: Creates a new instance of the Spartan Engine API.
createActionManager() - Method in interface org.spartan.api.SpartanApi: Creates a new Action Manager.
createApi() - Method in interface org.spartan.api.spi.SpartanApiProvider
createAutoEncoderCompressor(String, AutoEncoderCompressorConfig, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates an AutoEncoder Compressor model.
createAutoEncoderCompressorConfig(double, double, double, double, double, boolean, boolean, int, int, int, int, double) - Method in interface org.spartan.api.engine.config.spi.SpartanConfigFactoryServiceProvider
createContext(String) - Method in interface org.spartan.api.SpartanApi: Creates a new Observation Context.
createCuriosityDrivenRecurrentSoftActorCritic(String, CuriosityDrivenRecurrentSoftActorCriticConfig, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates a Curiosity-Driven RSAC agent.
createCuriosityDrivenRecurrentSoftActorCriticConfig(RecurrentSoftActorCriticConfig, int, double, double, double, double, int, double, double) - Method in interface org.spartan.api.engine.config.spi.SpartanConfigFactoryServiceProvider
createDoubleDeepQNetwork(String, DoubleDeepQNetworkConfig, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates a Double Deep Q-Network (DDQN) agent.
createDoubleDeepQNetworkConfig(double, double, double, double, double, boolean, boolean, int, int, int, int, int) - Method in interface org.spartan.api.engine.config.spi.SpartanConfigFactoryServiceProvider
createModel(String, SpartanModelConfigType, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Generic method to create a model from any configuration.
createMultiAgentGroupConfig(double, double, double, double, double, boolean, boolean, int) - Method in interface org.spartan.api.engine.config.spi.SpartanConfigFactoryServiceProvider
createMultiAgentModel(String, SpartanMultiAgentGroupConfig, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates a Multi-Agent model with an explicit group configuration.
createMultiAgentModel(String, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates a Multi-Agent model that shares the same context and action manager.
createProximalPolicyOptimizationConfig(double, double, double, double, double, boolean, boolean, int, int, int, int, int, int, int, double, double, double, double, double, double) - Method in interface org.spartan.api.engine.config.spi.SpartanConfigFactoryServiceProvider
createProximalPolicyOptimizationModel(String, ProximalPolicyOptimizationConfig, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates a Proximal Policy Optimization Model (PPO)
createRecurrentSoftActorCritic(String, RecurrentSoftActorCriticConfig, SpartanContext, SpartanActionManager) - Method in interface org.spartan.api.SpartanApi: Creates a Recurrent Soft Actor-Critic (RSAC) agent.
createRecurrentSoftActorCriticConfig(double, double, double, double, double, boolean, boolean, int, int, int, int, int, int, double, double, double, double, double, int, int, double, double, double, double, int) - Method in interface org.spartan.api.engine.config.spi.SpartanConfigFactoryServiceProvider
criticHiddenLayerCount() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Number of hidden layers in the Critic network.
criticHiddenLayerCount() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the number of hidden layers in the Critic network.
criticHiddenLayerCount(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
criticHiddenLayerCount(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
criticHiddenLayerCount(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
criticHiddenLayerNeuronCount() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the number of neurons in each hidden layer of the Critic network.
criticHiddenLayerNeuronCount(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
criticHiddenLayerNeuronCount(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
criticHiddenNeuronCount() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Neurons per hidden layer in the Critic (value baseline) network.
criticHiddenNeuronCount(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
CURIOSITY_DRIVEN_RECURRENT_SOFT_ACTOR_CRITIC - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: Curiosity-Driven Recurrent Soft Actor-Critic model.
CuriosityDrivenRecurrentSoftActorCriticConfig - Interface in org.spartan.api.engine.config: Configuration for the Curiosity-Driven Recurrent Soft Actor-Critic model.
CuriosityDrivenRecurrentSoftActorCriticConfig.Builder - Class in org.spartan.api.engine.config
CuriosityDrivenRecurrentSoftActorCriticModel - Interface in org.spartan.api.engine.model: An exploration-driven variant of RSAC that learns through intrinsic curiosity.
currentValidSize() - Method in record class org.spartan.api.engine.context.ValueRange: Returns the value of the currentValidSize record component.

D

dataCache - Variable in class org.spartan.api.engine.context.element.hot.SpartanHotContextElement
debugLogging() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
debugLogging() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns whether debug logging is enabled for the native engine.
debugLogging(boolean) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
debugLogging(boolean) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
debugLogging(boolean) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
debugLogging(boolean) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
debugLogging(boolean) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
debugLogging(boolean) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
decayExploration() - Method in interface org.spartan.api.engine.SpartanModel: Triggers exploration rate decay for this agent.
decayExplorationForAll() - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Decays exploration rate for all agents.
decoderLayerCount() - Method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig: Returns the depth of the Decoder half.
decoderLayerCount(int) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
DEFAULT - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: Default/placeholder model type.
DOUBLE_DEEP_Q_NETWORK - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: Double Deep Q-Network (DDQN) model.
DoubleDeepQNetworkConfig - Interface in org.spartan.api.engine.config: Configuration for the Double Deep Q-Network (DDQN) model.
DoubleDeepQNetworkConfig.Builder - Class in org.spartan.api.engine.config
DoubleDeepQNetworkModel - Interface in org.spartan.api.engine.model: A classic deep reinforcement learning agent for discrete action spaces.

E

encoderHiddenNeuronCount() - Method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig: Returns the width of the encoder/decoder hidden layers.
encoderHiddenNeuronCount(int) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
encoderLayerCount() - Method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig: Returns the depth of the Encoder half.
encoderLayerCount(int) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
entropyCoefficient() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Coefficient for the entropy bonus added to the policy loss.
entropyCoefficient(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
entropyTemperatureAlpha() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the temperature parameter (Alpha) for entropy regularization.
entropyTemperatureAlpha(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
entropyTemperatureAlpha(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
epsilon() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
epsilon() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
epsilon() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns the initial exploration probability for epsilon-greedy strategies.
epsilon(double) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
epsilon(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
epsilon(double) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
epsilon(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
epsilon(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
epsilon(double) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
epsilonDecay() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
epsilonDecay() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
epsilonDecay() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns the decay rate applied to epsilon after each training step.
epsilonDecay(double) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
epsilonDecay(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
epsilonDecay(double) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
epsilonDecay(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
epsilonDecay(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
epsilonDecay(double) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
epsilonMin() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
epsilonMin() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
epsilonMin() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns the minimum possible value for epsilon after decay.
epsilonMin(double) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
epsilonMin(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
epsilonMin(double) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
epsilonMin(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
epsilonMin(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
epsilonMin(double) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
equals(Object) - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.spartan.api.engine.context.ValueRange: Indicates whether some other object is "equal to" this one.

F

firstCriticLearningRate() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the specific learning rate for the first Q-Critic (Twin Critics).
firstCriticLearningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
firstCriticLearningRate(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
forwardDynamicsHiddenLayerDimensionSize() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the size of the hidden layers in the Forward Dynamics Model.
forwardDynamicsHiddenLayerDimensionSize(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
forwardDynamicsLearningRate() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the learning rate specifically for the world model (Forward Dynamics).
forwardDynamicsLearningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
fromNativeValue(int) - Static method in enum class org.spartan.api.engine.config.SpartanModelType: Converts a native value to the corresponding enum constant.

G

gaeGamma() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Discount factor used inside GAE for return computation.
gaeGamma(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
gaeLambda() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: GAE lambda — bias-variance trade-off for advantage estimation.
gaeLambda(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
gamma() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
gamma() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
gamma() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns the discount factor for future rewards.
gamma(double) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
gamma(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
gamma(double) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
gamma(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
gamma(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
gamma(double) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
get() - Static method in class org.spartan.api.engine.config.spi.SpartanConfigRegistry
get() - Static method in class org.spartan.api.spi.SpartanCoreRegistry
getActionManager() - Method in interface org.spartan.api.engine.SpartanAgent: Returns the action manager for this agent.
getActionOutputBuffer() - Method in interface org.spartan.api.engine.SpartanModel: Returns the action output buffer where C++ writes predictions.
getActions() - Method in interface org.spartan.api.engine.action.SpartanActionManager: Returns all registered actions.
getActionsByIdentifier(String) - Method in interface org.spartan.api.engine.action.SpartanActionManager: Finds and returns all actions matching a string identifier.
getActionsByType(Class) - Method in interface org.spartan.api.engine.action.SpartanActionManager: Finds and returns all actions of a specific class type.
getAgent(long) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Gets an agent by its numeric ID (O(1)).
getAgentByIdentifier(String) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Gets an agent by its string identifier.
getAgentCount() - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Returns the number of active agents in this group.
getAgentIdentifier() - Method in interface org.spartan.api.engine.SpartanModel: Returns the unique ID assigned to this agent by the Spartan Engine.
getAndResetEpisodeReward() - Method in interface org.spartan.api.engine.SpartanAgent: Gets the episode reward and atomically resets it in one call.
getBestActionIndex() - Method in interface org.spartan.api.engine.model.DoubleDeepQNetworkModel: Returns the index of the action with the highest Q-value (greedy action).
getContext() - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Returns the SHARED context.
getCriticWeightsBuffer() - Method in interface org.spartan.api.engine.SpartanAgent: Returns the critic weights buffer.
getData() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Returns the compressed latent representation for this tick.
getData() - Method in class org.spartan.api.engine.context.element.hot.SpartanHotContextElement
getData() - Method in interface org.spartan.api.engine.context.element.SpartanContextElement: Returns the backing data array for this element.
getData() - Method in class org.spartan.api.engine.context.element.SpartanSingleContextElement
getData() - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement
getDataCache() - Method in class org.spartan.api.engine.context.element.hot.SpartanHotContextElement: Returns a reference to the mutable data cache for direct modification during SpartanContextElement.tick().
getDataCache() - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement: Returns a reference to the mutable data cache for direct modification during SpartanContextElement.tick().
getElementByIdentifier(String) - Method in interface org.spartan.api.engine.context.SpartanContext: Gets the element with the specified identifier.
getElements() - Method in interface org.spartan.api.engine.context.SpartanContext
getElementsOfType(Class) - Method in interface org.spartan.api.engine.context.SpartanContext: Gets the elements of the specified type.
getEmbeddedRecurrentSoftActorCriticConfig() - Method in interface org.spartan.api.engine.model.CuriosityDrivenRecurrentSoftActorCriticModel: Returns the embedded RSAC configuration that this curiosity model wraps.
getEpisodeReward() - Method in interface org.spartan.api.engine.SpartanAgent: Returns the current cumulative reward for this episode.
getEpisodeReward() - Method in interface org.spartan.api.engine.SpartanModel: Retrieves the current accumulated reward for the ongoing episode.
getErrorCode() - Method in exception class org.spartan.api.exception.SpartanNativeException: Returns the native error code from C++.
getIdentifier() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Returns a user-friendly identifier for this compressed element.
getIdentifier() - Method in interface org.spartan.api.engine.context.element.SpartanContextElement
getIdentifier() - Method in interface org.spartan.api.engine.context.SpartanContext
getIdentifier() - Method in interface org.spartan.api.engine.SpartanModel: Returns the unique string identifier provided at creation.
getInternalCompressor() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Returns the internal compressor for advanced use cases.
getLatentBuffer() - Method in interface org.spartan.api.engine.SpartanCompressor: Returns the memory segment containing the compressed "Latent Representation".
getModelWeightsBuffer() - Method in interface org.spartan.api.engine.SpartanModel: Returns the model weights buffer.
getNativeValue() - Method in enum class org.spartan.api.engine.config.SpartanModelType: Returns the native C++ enum value.
getRawElement() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Returns the raw element (before compression).
getReconstructionBuffer() - Method in interface org.spartan.api.engine.SpartanCompressor: Returns the reconstruction output buffer.
getReconstructionLoss() - Method in interface org.spartan.api.engine.SpartanCompressor: Returns the current reconstruction loss (MSE between input and output).
getSize() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Returns the compressed size (latent dimension).
getSize() - Method in class org.spartan.api.engine.context.element.hot.SpartanHotContextElement
getSize() - Method in interface org.spartan.api.engine.context.element.SpartanContextElement
getSize() - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement
getSize() - Method in interface org.spartan.api.engine.context.SpartanContext: Returns the total size of the observed world.
getSpartanContext() - Method in interface org.spartan.api.engine.SpartanModel: Returns the context attached to this model.
getSpartanModelConfig() - Method in interface org.spartan.api.engine.SpartanModel: Returns the configuration used to create this model.
getValue() - Method in class org.spartan.api.engine.context.element.SpartanSingleContextElement

H

hashCode() - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Returns a hash code value for this object.
hashCode() - Method in record class org.spartan.api.engine.context.ValueRange: Returns a hash code value for this object.
hiddenLayerCount() - Method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig: Returns the depth of the neural network.
hiddenLayerCount(int) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
hiddenLayerNeuronCount() - Method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig: Returns the width of the hidden layers.
hiddenLayerNeuronCount(int) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
hiddenNeuronCount() - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Returns the value of the hiddenNeuronCount record component.
hiddenStateSize() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the size of the recurrent hidden state (memory vector).
hiddenStateSize(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
hiddenStateSize(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder

I

identifier() - Method in interface org.spartan.api.engine.action.type.SpartanAction: Returns the unique identifier for this action.
intrinsicRewardClampingMaximum() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the maximum clamp value for intrinsic rewards.
intrinsicRewardClampingMaximum(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
intrinsicRewardClampingMinimum() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the minimum clamp value for intrinsic rewards.
intrinsicRewardClampingMinimum(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
intrinsicRewardScale() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the scaling factor for intrinsic rewards (curiosity).
intrinsicRewardScale(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
inverseDynamicsHiddenLayerDimensionSize() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the size of the hidden layers in the Inverse Dynamics Model.
inverseDynamicsHiddenLayerDimensionSize(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
inverseDynamicsLearningRate() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the learning rate specifically for the Inverse Dynamics Model.
inverseDynamicsLearningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
inverseLossWeight() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the weight applied to inverse loss during curiosity training.
inverseLossWeight(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
isRegistered() - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Checks if this group is registered with C++.
isRegistered() - Method in interface org.spartan.api.engine.SpartanModel: Checks if this model is currently registered with the C++ engine.
isTraining() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
isTraining() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
isTraining() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns whether the model is in training mode.
isTraining(boolean) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
isTraining(boolean) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
isTraining(boolean) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
isTraining(boolean) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
isTraining(boolean) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
isTraining(boolean) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder

L

latentDimensionSize() - Method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig: Returns the size of the compressed representation.
latentDimensionSize() - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Returns the value of the latentDimensionSize record component.
latentDimensionSize(int) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
learningRate() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
learningRate() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
learningRate() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns the step size for the optimizer's gradient descent updates.
learningRate(double) - Method in class org.spartan.api.engine.config.AutoEncoderCompressorConfig.Builder
learningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
learningRate(double) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
learningRate(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
learningRate(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
learningRate(double) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
load(Path) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Loads the submodels from a compressed multi-agent .spartan file package.
load(Path) - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Loads the internal compressor's state from a file.
loadModel(Path) - Method in interface org.spartan.api.engine.SpartanModel: Loads model weights from a .spartan binary file.

M

maxAgents() - Method in interface org.spartan.api.engine.config.SpartanMultiAgentGroupConfig: Maximum number of agents allowed in the group.
maxAgents(int) - Method in class org.spartan.api.engine.config.SpartanMultiAgentGroupConfig.Builder
maxCapacity() - Method in record class org.spartan.api.engine.context.ValueRange: Returns the value of the maxCapacity record component.
maxGradientNorm() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Maximum L2 norm for gradient clipping.
maxGradientNorm(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
miniBatchSize() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Mini-batch size drawn from the trajectory buffer during each epoch.
miniBatchSize(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
modelType() - Method in interface org.spartan.api.engine.config.AutoEncoderCompressorConfig
modelType() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig
modelType() - Method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig
modelType() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig
modelType() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig
modelType() - Method in interface org.spartan.api.engine.config.SpartanModelConfig: Returns the model type discriminator.
modelType() - Method in interface org.spartan.api.engine.config.SpartanMultiAgentGroupConfig
MULTI_AGENT_GROUP - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: Multi-Agent group container (not a per-agent model).

N

NestedEncoderSlotDescriptor - Record Class in org.spartan.api.engine.config: Descriptor for a nested AutoEncoder slot within an RSAC agent.
NestedEncoderSlotDescriptor(int, int, int, int) - Constructor for record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Validates descriptor parameters.

O

org.spartan.api - package org.spartan.api
org.spartan.api.engine - package org.spartan.api.engine
org.spartan.api.engine.action - package org.spartan.api.engine.action
org.spartan.api.engine.action.type - package org.spartan.api.engine.action.type
org.spartan.api.engine.config - package org.spartan.api.engine.config
org.spartan.api.engine.config.spi - package org.spartan.api.engine.config.spi
org.spartan.api.engine.context - package org.spartan.api.engine.context
org.spartan.api.engine.context.element - package org.spartan.api.engine.context.element
org.spartan.api.engine.context.element.compressed - package org.spartan.api.engine.context.element.compressed
org.spartan.api.engine.context.element.hot - package org.spartan.api.engine.context.element.hot
org.spartan.api.engine.context.element.variable - package org.spartan.api.engine.context.element.variable
org.spartan.api.engine.model - package org.spartan.api.engine.model
org.spartan.api.exception - package org.spartan.api.exception
org.spartan.api.spi - package org.spartan.api.spi

P

physicalEndIndex() - Method in record class org.spartan.api.engine.context.ValueRange: Returns the exclusive end index (physicalStartIndex + maxCapacity).
physicalStartIndex() - Method in record class org.spartan.api.engine.context.ValueRange: Returns the value of the physicalStartIndex record component.
policyNetworkLearningRate() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the specific learning rate for the Policy (Actor) network.
policyNetworkLearningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
policyNetworkLearningRate(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
prepare() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Prepares the raw element for the next tick.
prepare() - Method in class org.spartan.api.engine.context.element.hot.SpartanHotContextElement
prepare() - Method in interface org.spartan.api.engine.context.element.SpartanContextElement: Prepares the element for ticking (clears caches, resets counters, etc.).
prepare() - Method in class org.spartan.api.engine.context.element.SpartanSingleContextElement
prepare() - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement
PROXIMAL_POLICY_OPTIMIZATION - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: Proximity policy optimization
ProximalPolicyOptimizationConfig - Interface in org.spartan.api.engine.config: Configuration for the Proximal Policy Optimization (PPO) model.
ProximalPolicyOptimizationConfig.Builder - Class in org.spartan.api.engine.config
ProximalPolicyOptimizationModel - Interface in org.spartan.api.engine.model: PPO Agent interface for continuous action spaces using clipped surrogate objectives.

R

readActionValue(int) - Method in interface org.spartan.api.engine.model.CuriosityDrivenRecurrentSoftActorCriticModel: Reads the predicted action value for a specific action dimension.
readActionValue(int) - Method in interface org.spartan.api.engine.model.ProximalPolicyOptimizationModel: Reads a specific action value from the actor's output.
readActionValue(int) - Method in interface org.spartan.api.engine.model.RecurrentSoftActorCriticModel: Reads the predicted action value for a specific action dimension.
readAllActionValues() - Method in interface org.spartan.api.engine.model.CuriosityDrivenRecurrentSoftActorCriticModel: Reads all predicted action values.
readAllActionValues() - Method in interface org.spartan.api.engine.model.ProximalPolicyOptimizationModel: Reads all predicted action values (Zero-Copy recommended via buffers).
readAllActionValues() - Method in interface org.spartan.api.engine.model.RecurrentSoftActorCriticModel: Reads all predicted action values.
readAllLatent() - Method in interface org.spartan.api.engine.SpartanCompressor: Reads all latent values into a new array.
readAllQValues() - Method in interface org.spartan.api.engine.model.DoubleDeepQNetworkModel: Returns all Q-values for every discrete action.
readAllReconstruction() - Method in interface org.spartan.api.engine.model.AutoEncoderCompressorModel: Reads all reconstruction values into a new array.
readDouble(int) - Method in interface org.spartan.api.engine.context.SpartanContext: Reads a double value from the shared memory at the specified index.
readDoubles(int, int) - Method in interface org.spartan.api.engine.context.SpartanContext: Reads multiple double values from the shared memory starting at the specified index.
readLatent(int) - Method in interface org.spartan.api.engine.SpartanCompressor: Reads a single latent dimension value.
readLatentIntoBuffer(double[]) - Method in interface org.spartan.api.engine.model.AutoEncoderCompressorModel: Reads latent values into an existing buffer.
readQValue(int) - Method in interface org.spartan.api.engine.model.DoubleDeepQNetworkModel: Reads the Q-value for a specific discrete action.
readQValuesIntoBuffer(double[]) - Method in interface org.spartan.api.engine.model.DoubleDeepQNetworkModel: Reads all Q-values into a pre-allocated buffer.
readReconstruction(int) - Method in interface org.spartan.api.engine.model.AutoEncoderCompressorModel: Reads a single reconstruction value for a specific state dimension.
RECURRENT_SOFT_ACTOR_CRITIC - Enum constant in enum class org.spartan.api.engine.config.SpartanModelType: Recurrent Soft Actor-Critic (RSAC) model.
recurrentInputFeatureCount() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the size of the input features processed by the recurrent unit.
recurrentInputFeatureCount(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
recurrentInputFeatureCount(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
recurrentLayerDepth() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the number of stacked recurrent layers (GRU depth).
recurrentLayerDepth(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
recurrentLayerDepth(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
recurrentSoftActorCriticConfig() - Method in interface org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig: Returns the base RSAC configuration.
recurrentSoftActorCriticConfig(RecurrentSoftActorCriticConfig) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
RecurrentSoftActorCriticConfig - Interface in org.spartan.api.engine.config: Configuration for the Recurrent Soft Actor-Critic (RSAC) model.
RecurrentSoftActorCriticConfig.Builder - Class in org.spartan.api.engine.config: Builder for RecurrentSoftActorCriticConfig.
RecurrentSoftActorCriticModel - Interface in org.spartan.api.engine.model: A sophisticated deep reinforcement learning agent for continuous control with temporal memory.
register() - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Registers this multi-agent group with the C++ engine.
register() - Method in interface org.spartan.api.engine.SpartanModel: Registers this model with the C++ engine.
registerAction(SpartanAction) - Method in interface org.spartan.api.engine.action.SpartanActionManager: Registers a new action.
remorseMinimumSimilarityThreshold() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the minimum similarity threshold for trace retention.
remorseMinimumSimilarityThreshold(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
remorseMinimumSimilarityThreshold(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
remorseTraceBufferCapacity() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the capacity of the REMORSE (Recurrent Memory Oriented Replay Storage Experience) buffer.
remorseTraceBufferCapacity(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
remorseTraceBufferCapacity(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
removeAgent(long) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Removes an agent from the group (O(1)).
removeElement(SpartanContextElement) - Method in interface org.spartan.api.engine.context.SpartanContext: Removes an element from this context.
removeElementsByIdentifier(String) - Method in interface org.spartan.api.engine.context.SpartanContext: Removes all elements with the specified identifier from this context.
removeElementsOfType(Class) - Method in interface org.spartan.api.engine.context.SpartanContext: Removes all elements of the specified type from this context.
replayBatchSize() - Method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig: Returns the number of experiences trained on per tick.
replayBatchSize(int) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
replayBufferCapacity() - Method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig: Returns the maximum size of the Experience Replay Buffer.
replayBufferCapacity(int) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
resetEpisode() - Method in interface org.spartan.api.engine.SpartanAgent: Resets the episode state (reward accumulator, hidden states, etc.).
resetEpisode() - Method in interface org.spartan.api.engine.SpartanModel: Resets the accumulated reward for the new episode.

S

save(Path) - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Saves all embedded submodels into a compressed .spartan file package.
save(Path) - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Saves the internal compressor's state to a file.
saveModel(Path) - Method in interface org.spartan.api.engine.SpartanModel: Saves the model's complete state to a .spartan binary file.
secondCriticLearningRate() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the specific learning rate for the second Q-Critic.
secondCriticLearningRate(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
secondCriticLearningRate(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
set(int, boolean) - Method in class org.spartan.api.engine.context.element.hot.SpartanMultiHotContextElement: Sets the state of a specific index without clearing other indices.
set(int, boolean) - Method in class org.spartan.api.engine.context.element.hot.SpartanOneHotContextElement: Sets a single active index (all others become zero).
set(int, double) - Method in class org.spartan.api.engine.context.element.hot.SpartanFuzzyHotContextElement: Sets a continuous activation value for the given index.
set(SpartanConfigFactoryServiceProvider) - Static method in class org.spartan.api.engine.config.spi.SpartanConfigRegistry
set(SpartanApiProvider) - Static method in class org.spartan.api.spi.SpartanCoreRegistry
setLiveExplorationRate(double) - Method in interface org.spartan.api.engine.SpartanModel: Modifies the exploration rate (epsilon) live while the model is running.
setSize(int) - Method in class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement: Manually sets the filled index count.
SpartanAction - Interface in org.spartan.api.engine.action.type: Represents a single atomic capability of an Agent.
SpartanActionManager - Interface in org.spartan.api.engine.action: Manages the registry of actions available to an agent.
SpartanAgent<SpartanModelConfigType> - Interface in org.spartan.api.engine: Represents an active "Decision Maker" agent.
SpartanApi - Interface in org.spartan.api: The main entry point for the Spartan Deep Learning engine.
SpartanApiProvider - Interface in org.spartan.api.spi
SpartanCompressor<SpartanModelConfigType> - Interface in org.spartan.api.engine: Represents a passive "Data Processor" model.
SpartanConfigFactoryServiceProvider - Interface in org.spartan.api.engine.config.spi: Service Provider Interface (SPI) for creating concrete configuration implementations.
SpartanConfigRegistry - Class in org.spartan.api.engine.config.spi: Registry to hold the concrete implementation of configuration creation.
SpartanContext - Interface in org.spartan.api.engine.context: Represents the agent's perception of the world.
SpartanContextElement - Interface in org.spartan.api.engine.context.element: Base contract for a single context element (sensor) that contributes values to a SpartanContext.
SpartanCoreRegistry - Class in org.spartan.api.spi
SpartanFuzzyHotContextElement - Class in org.spartan.api.engine.context.element.hot
SpartanFuzzyHotContextElement(int) - Constructor for class org.spartan.api.engine.context.element.hot.SpartanFuzzyHotContextElement: Fuzzy hot context allows partial activation of characteristics in the array.
SpartanHotContextElement - Class in org.spartan.api.engine.context.element.hot: Base class for fixed-size hot-encoded elements.
SpartanHotContextElement(int) - Constructor for class org.spartan.api.engine.context.element.hot.SpartanHotContextElement: Size is needed for hot encoding, since elements should have a fixed amount of characteristics.
SpartanModel<SpartanModelConfigType> - Interface in org.spartan.api.engine: Represents an instance of a Machine Learning brain.
SpartanModelConfig - Interface in org.spartan.api.engine.config: Base configuration interface for all Spartan ML models.
SpartanModelType - Enum Class in org.spartan.api.engine.config: Discriminator identifying which model family a config belongs to.
SpartanMultiAgentGroupConfig - Interface in org.spartan.api.engine.config: Configuration for a Multi-Agent group container.
SpartanMultiAgentGroupConfig.Builder - Class in org.spartan.api.engine.config
SpartanMultiAgentModel<ConfigType> - Interface in org.spartan.api.engine.model: Group of N homogeneous agents sharing a single SpartanContext.
SpartanMultiHotContextElement - Class in org.spartan.api.engine.context.element.hot
SpartanMultiHotContextElement(int) - Constructor for class org.spartan.api.engine.context.element.hot.SpartanMultiHotContextElement
SpartanNativeException - Exception Class in org.spartan.api.exception: Exception thrown when a native Spartan engine operation fails.
SpartanNativeException(String, int) - Constructor for exception class org.spartan.api.exception.SpartanNativeException: Creates a new native exception with a message and error code.
SpartanNativeException(String, Throwable, int) - Constructor for exception class org.spartan.api.exception.SpartanNativeException: Creates a new native exception with a message, cause, and error code.
SpartanOneHotContextElement - Class in org.spartan.api.engine.context.element.hot
SpartanOneHotContextElement(int) - Constructor for class org.spartan.api.engine.context.element.hot.SpartanOneHotContextElement
SpartanPersistenceException - Exception Class in org.spartan.api.exception: Exception thrown when model persistence operations fail.
SpartanPersistenceException(String) - Constructor for exception class org.spartan.api.exception.SpartanPersistenceException: Creates a new persistence exception with a message.
SpartanPersistenceException(String, Throwable) - Constructor for exception class org.spartan.api.exception.SpartanPersistenceException: Creates a new persistence exception with a message and cause.
SpartanSingleContextElement - Class in org.spartan.api.engine.context.element: Convenience base class for a single scalar context element.
SpartanSingleContextElement() - Constructor for class org.spartan.api.engine.context.element.SpartanSingleContextElement
SpartanVariableContextElement - Class in org.spartan.api.engine.context.element.variable: Base class for variable-length context elements.
SpartanVariableContextElement() - Constructor for class org.spartan.api.engine.context.element.variable.SpartanVariableContextElement
squashActionsWithTanh() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns whether tanh squashing is enabled for policy actions.
squashActionsWithTanh(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
squashActionsWithTanh(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder

T

targetEntropy() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the target entropy for automatic alpha tuning.
targetEntropy(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
targetEntropy(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
targetNetworkSyncInterval() - Method in interface org.spartan.api.engine.config.DoubleDeepQNetworkConfig: Returns the frequency (in ticks) at which the Target Network is updated.
targetNetworkSyncInterval(int) - Method in class org.spartan.api.engine.config.DoubleDeepQNetworkConfig.Builder
targetSmoothingCoefficient() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns the interpolation factor (Tau) for target network updates.
targetSmoothingCoefficient(double) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
targetSmoothingCoefficient(double) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder
task(double) - Method in interface org.spartan.api.engine.action.type.SpartanAction: Executes the logic.
taskMaxMagnitude() - Method in interface org.spartan.api.engine.action.type.SpartanAction: Defines the maximum physical value for this action.
taskMinMagnitude() - Method in interface org.spartan.api.engine.action.type.SpartanAction: Defines the minimum physical value for this action.
tick() - Method in class org.spartan.api.engine.context.element.compressed.CompressedVariableContextElement: Updates the compressor with current data.
tick() - Method in interface org.spartan.api.engine.context.element.SpartanContextElement: Updates the element values for the current tick.
tick() - Method in interface org.spartan.api.engine.model.SpartanMultiAgentModel: Hot-path: Executes a MARL CTDE tick.
tick() - Method in interface org.spartan.api.engine.SpartanModel: Hot-path method: updates context and triggers native inference.
tick(double) - Method in interface org.spartan.api.engine.action.type.SpartanAction: Internal Method (Do Not Override): Orchestrates the Action Lifecycle: Receives raw output from Neural Network [-1, 1]. Denormalizes it to [min, max]. Calls SpartanAction.task(double) to execute. Calls SpartanAction.award() to score the previous tick.
tick(double) - Method in interface org.spartan.api.engine.SpartanAgent: Hot-path method: applies reward and triggers native inference in one call.
toString() - Method in record class org.spartan.api.engine.config.NestedEncoderSlotDescriptor: Returns a string representation of this record class.
toString() - Method in record class org.spartan.api.engine.context.ValueRange: Returns a string representation of this record class.
trainingEpochCount() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Number of full passes over the trajectory buffer per update.
trainingEpochCount(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
trajectoryBufferCapacity() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Number of environment steps collected before each policy update.
trajectoryBufferCapacity(int) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
truncatedBPTTDepth() - Method in interface org.spartan.api.engine.config.RecurrentSoftActorCriticConfig: Returns truncated BPTT depth for GRU training.
truncatedBPTTDepth(int) - Method in class org.spartan.api.engine.config.CuriosityDrivenRecurrentSoftActorCriticConfig.Builder
truncatedBPTTDepth(int) - Method in class org.spartan.api.engine.config.RecurrentSoftActorCriticConfig.Builder

U

update() - Method in interface org.spartan.api.engine.context.element.SpartanContextElement: Internal lifecycle hook that calls SpartanContextElement.prepare() and SpartanContextElement.tick() in order.
update() - Method in interface org.spartan.api.engine.context.SpartanContext: Refreshes the agent's view of the world.

V

valueLossCoefficient() - Method in interface org.spartan.api.engine.config.ProximalPolicyOptimizationConfig: Coefficient applied to the value function loss before adding to the total loss.
valueLossCoefficient(double) - Method in class org.spartan.api.engine.config.ProximalPolicyOptimizationConfig.Builder
valueOf(String) - Static method in enum class org.spartan.api.engine.config.SpartanModelType: Returns the enum constant of this class with the specified name.
ValueRange - Record Class in org.spartan.api.engine.context: Represents a fixed block of memory allocated to a context element.
ValueRange(int, int, int) - Constructor for record class org.spartan.api.engine.context.ValueRange: Compact validation for ValueRange parameters.
values() - Static method in enum class org.spartan.api.engine.config.SpartanModelType: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form