Node.h

Go to the documentation of this file.

/*
GRT MIT License
Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef GRT_NODE_HEADER
#define GRT_NODE_HEADER

#include "../../CoreModules/MLBase.h"

GRT_BEGIN_NAMESPACE

class GRT_API Node : public MLBase{
public:
    Node( const std::string id = "Node" );
    
    virtual ~Node();
    
    virtual bool predict_(VectorFloat &x) override;
    
    virtual bool predict_(VectorFloat &x,VectorFloat &y);
    
    virtual bool computeFeatureWeights( VectorFloat &weights ) const;
    
    virtual bool computeLeafNodeWeights( MatrixFloat &weights ) const;
    
    virtual bool clear() override;
    
    virtual bool print() const override;
    
    virtual bool getModel( std::ostream &stream ) const override;
    
    virtual bool save( std::fstream &file ) const override;
    
    virtual bool load( std::fstream &file ) override;
    
    virtual Node* deepCopy() const;
    
    std::string getNodeType() const;
    
    UINT getDepth() const;
    
    UINT getNodeID() const;
    
    UINT getPredictedNodeID() const;
    
    UINT getMaxDepth() const;
    
    bool getIsLeafNode() const;
    
    bool getHasParent() const;
    
    bool getHasLeftChild() const;
    
    bool getHasRightChild() const;
    
    Node *getParent() const { return parent; }
    Node *getLeftChild() const { return leftChild; }
    Node *getRightChild() const { return rightChild; }
    
    bool initNode(Node *parent,const UINT depth,const UINT nodeID,const bool isLeafNode = false);
    
    bool setParent(Node *parent);
    
    bool setLeftChild(Node *leftChild);
    
    bool setRightChild(Node *rightChild);
    
    bool setDepth(const UINT depth);
    
    bool setNodeID(const UINT nodeID);
    
    bool setIsLeafNode(const bool isLeafNode);
    
    typedef std::map< std::string, Node*(*)() > StringNodeMap;
    
    static Node* createInstanceFromString( std::string const &nodeType );
    
    Node* createNewInstance() const;

    using MLBase::save;
    using MLBase::load;
    using MLBase::predict;
    using MLBase::predict_;
    
protected:
    
    virtual bool saveParametersToFile( std::fstream &file ) const{ return true; }
    
    virtual bool loadParametersFromFile( std::fstream &file ){ return true; }
    
    std::string nodeType;
    UINT depth;
    UINT nodeID;
    UINT predictedNodeID;
    bool isLeafNode;
    Node *parent;
    Node *leftChild;
    Node *rightChild;
    
    static StringNodeMap *getMap() {
        if( !stringNodeMap ){ stringNodeMap = new StringNodeMap; }
        return stringNodeMap;
    }
    
private:
    static StringNodeMap *stringNodeMap;
    static UINT numNodeInstances;  
};

//These two functions/classes are used to register any new Node with the Node base class
template< typename T >  Node* getNewNodeInstance() { return new T; }

template< typename T >
class RegisterNode : Node {
    public:
    RegisterNode(std::string const &newNodeName) {
        getMap()->insert( std::pair< std::string, Node*(*)() >(newNodeName, &getNewNodeInstance< T > ) );
    }
};

GRT_END_NAMESPACE

#endif //GRT_NODE_HEADER