substitute.hh

Go to the documentation of this file.

 
#pragma once
 
#include "Algorithm.hh"
#include "algorithms/sort_product.hh"
#include "lru_cache.hh"
 
namespace cadabra {
 
 
    class substitute : public Algorithm {
        public:
            substitute(const Kernel&, Ex& tr, Ex& args, bool partial=true);
 
 
            virtual bool     can_apply(iterator st);
 
            virtual result_t apply(iterator&);
 
            Ex_comparator comparator;
 
            static size_t cache_size();
 
        private:
            Ex&     args;
 
            iterator      use_rule;
            iterator      conditions;
 
            std::map<iterator, bool> lhs_contains_dummies, rhs_contains_dummies;
 
            // For object swap testing routines:
            sort_product    sort_product_;
            bool            partial;
            
            // Rules is a class for caching properties of substitution
            // rules to avoid processing them in subsequent calls.
 
            class Rules {
 
                public:
                    Rules(size_t max_size_=1000, size_t cleanup_threshold_=100) 
                        : properties(max_size_), max_size(max_size_), cleanup_threshold(cleanup_threshold_) {}
 
                    // Associate rule properties with a specific object
                    void store(Ex& rules,
                                  std::map<iterator, bool>& lhs_contains_dummies,
                                  std::map<iterator, bool>& rhs_contains_dummies);
                    
                    // Check if rules are present
                    bool is_present(Ex& rules) const;
                    
                    // Retrieve properties from rules
                    void retrieve(Ex& rules,
                                      std::map<iterator, bool>& lhs_contains_dummies,
                                      std::map<iterator, bool>& rhs_contains_dummies) const;
                    
                    // Count number of rules
                    size_t size() const;
                    
                    // Eliminate rules that are expired
                    void cleanup();
 
                private:
                    // Map storing weak pointers to `Ex` and pairs of lhs/rhs maps as values
                    mutable LRUcache<std::weak_ptr<Ex>, 
                                        std::pair< std::map<iterator, bool>, std::map<iterator, bool> >,
                                        std::owner_less<std::weak_ptr<Ex>>
                                        > properties;
                    // Max size of the rules list
                    size_t max_size;
                    // Initial size threshold to trigger cleanup_rules
                    size_t cleanup_threshold;
 
 
                };
 
            // Shared instance of all replacement rules.
            static Rules    replacement_rules;
            static size_t   cache_hits, cache_misses;
            
    };
 
 
    }