Agent.h

Go to the documentation of this file.

/************************************************************************
* Verve                                                                 *
* Copyright (C) 2004-2006                                               *
* Tyler Streeter  tylerstreeter@gmail.com                               *
* All rights reserved.                                                  *
* Web: http://verve-agents.sourceforge.net                              *
*                                                                       *
* This library is free software; you can redistribute it and/or         *
* modify it under the terms of EITHER:                                  *
*   (1) The GNU Lesser General Public License as published by the Free  *
*       Software Foundation; either version 2.1 of the License, or (at  *
*       your option) any later version. The text of the GNU Lesser      *
*       General Public License is included with this library in the     *
*       file license-LGPL.txt.                                          *
*   (2) The BSD-style license that is included with this library in     *
*       the file license-BSD.txt.                                       *
*                                                                       *
* This library is distributed in the hope that it will be useful,       *
* but WITHOUT ANY WARRANTY; without even the implied warranty of        *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files    *
* license-LGPL.txt and license-BSD.txt for more details.                *
************************************************************************/

#ifndef VERVE_AGENT_H
#define VERVE_AGENT_H

#include "Globals.h"
#include "AgentDescriptor.h"
#include "Observation.h"

namespace verve
{
        class Observation;
        class PredictiveModel;
        class RLModule;

        class Agent
        {
        public:
                VERVE_DECL Agent(const AgentDescriptor& desc);

                // TODO: VERVE_DECL Agent(const Agent& a);

                // TODO: VERVE_DECL Agent(const std::string& filename);

                VERVE_DECL virtual ~Agent();

                VERVE_DECL virtual void VERVE_CALL destroy();

                VERVE_DECL virtual void VERVE_CALL resetShortTermMemory();

                VERVE_DECL virtual unsigned int VERVE_CALL update(
                        real reinforcement, const Observation& obs, real dt);

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getNumDiscreteSensors()const;

                VERVE_DECL virtual unsigned int VERVE_CALL 
                        getNumContinuousSensors()const;

                VERVE_DECL virtual void VERVE_CALL setETraceTimeConstant(
                        real timeConstant);

                VERVE_DECL virtual void VERVE_CALL setTDDiscountTimeConstant(
                        real timeConstant);

                VERVE_DECL virtual void VERVE_CALL setTDLearningRate(
                        real valueFunctionTimeConstant, real policyLearningMultiplier);

                VERVE_DECL virtual void VERVE_CALL setModelLearningRate(
                        real timeConstant);

                VERVE_DECL virtual void VERVE_CALL setLearningEnabled(
                        bool enabled);

                VERVE_DECL virtual long unsigned int VERVE_CALL getAge()const;

                VERVE_DECL virtual std::string VERVE_CALL getAgeString()const;

                VERVE_DECL virtual real VERVE_CALL getTDError()const;

                VERVE_DECL virtual real VERVE_CALL getModelMSE()const;

                VERVE_DECL virtual unsigned int VERVE_CALL getLastPlanLength()const;

                VERVE_DECL virtual real VERVE_CALL computeValueEstimation(
                        const Observation& obs);

                VERVE_DECL virtual const AgentDescriptor* VERVE_CALL 
                        getDescriptor()const;

                VERVE_DECL virtual void VERVE_CALL saveValueData(
                        unsigned int continuousResolution, 
                        const std::string& filename = "");

                VERVE_DECL virtual void VERVE_CALL saveStateRBFData(
                        const std::string& filename = "");

                //virtual void VERVE_CALL internal_load(const std::string& filename);

                //virtual void VERVE_CALL save(const std::string& filename = "");

        protected:
                void setStepSize(real value);

                unsigned int planningSequence(const Observation& predCurrentObs, 
                        real predCurrentReward, real currentUncertainty);

                void incrementAge();

                AgentDescriptor mDescriptor;

                RLModule* mRLModule;

                PredictiveModel* mPredictiveModel;

                bool mFirstStep;

                unsigned int mActionIndex;

                Observation mActualPrevObs;

                Observation mPredCurrentObs;

                Observation mTempPlanningObs;

                bool mLearningEnabled;

                real mStepSize;

                long unsigned int mAgeHours;

                unsigned int mAgeMinutes;

                real mAgeSeconds;

                unsigned int mLastPlanningSequenceLength;
        };
}

#endif

---