casadi::WeakCache< K, T > Class Template Reference

#include <generic_shared.hpp>

Detailed Description

template<typename K, typename T>
class casadi::WeakCache< K, T >

Key is stored as a regular ref Value is stored as weakref

Definition at line 242 of file generic_shared.hpp.

Public Member Functions
void	tocache (const K &key, const T &f, bool needs_lock=true, bool prune=true)
void	tocache_if_missing (const K &key, T &f, bool prune=true)
bool	incache (const K &key, T &f, bool needs_lock=true) const
void	prune ()
void	cache (std::vector< K > &keys, std::vector< T > &entries) const

Member Function Documentation

cache()

template<typename K , typename T >

void casadi::WeakCache< K, T >::cache ( std::vector< K > &  keys, std::vector< T > &  entries  ) const

inline

Definition at line 313 of file generic_shared.hpp.

                                                                {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
      // Safe access to cache_
      std::lock_guard<std::mutex> lock(mtx_);
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
      keys.clear();
      entries.clear();
      // Add all entries that haven't been deleted
      for (auto&& cf : cache_) {
        typename T::base_type temp;
        if (cf.second.shared_if_alive(temp)) {
          keys.push_back(cf.first);
          entries.push_back(shared_cast<T>(temp));
        }
      }
    }

incache()

template<typename K , typename T >

bool casadi::WeakCache< K, T >::incache ( const K &  key, T &  f, bool  needs_lock = true  ) const

inline

Definition at line 285 of file generic_shared.hpp.

                                                                 {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
      // Safe access to cache_
      casadi::conditional_lock_guard<std::mutex> lock(mtx_, needs_lock);
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
      auto it = cache_.find(key);
      typename T::base_type temp;
      if (it!=cache_.end() && it->second.shared_if_alive(temp)) {
        f = shared_cast<T>(temp);
        return true;
      } else {
        return false;
      }
    }

Referenced by casadi::CallSX::get_output().

prune()

template<typename K , typename T >

void casadi::WeakCache< K, T >::prune ( )

inline

Definition at line 300 of file generic_shared.hpp.

                 {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
      // Safe access to cache_
      std::lock_guard<std::mutex> lock(mtx_);
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
      for (auto it = cache_.begin(); it!=cache_.end();) {
        if (!it->second.alive()) {
          it = cache_.erase(it);
        } else {
          ++it;
        }
      }
    }

Referenced by casadi::CallSX::get_output().

tocache()

template<typename K , typename T >

void casadi::WeakCache< K, T >::tocache ( const K &  key, const T &  f, bool  needs_lock = true, bool  prune = true  )

inline

Definition at line 244 of file generic_shared.hpp.

                         {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
      // Safe access to cache_
      casadi::conditional_lock_guard<std::mutex> lock(mtx_, needs_lock);
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
      // Add to cache
      auto it = cache_.find(key);
 
      if (it == cache_.end()) {
        cache_.emplace(key, f);
      } else if (!it->second.alive()) {
        it->second = f;
      }
 
      // Remove a lost reference, if any, to prevent uncontrolled growth
      if (!prune) return;
      for (auto it = cache_.begin(); it!=cache_.end(); ++it) {
        if (!it->second.alive()) {
          cache_.erase(it);
          break; // just one dead reference is enough
        }
      }
    }

tocache_if_missing()

template<typename K , typename T >

void casadi::WeakCache< K, T >::tocache_if_missing ( const K &  key, T &  f, bool  prune = true  )

inline

Definition at line 276 of file generic_shared.hpp.

                                                                 {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
      // Safe access to cache_
      std::lock_guard<std::mutex> lock(mtx_);
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
      if (!incache(key, f, false)) {
        tocache(key, f, false, prune);
      }
    }

Referenced by casadi::CallSX::get_output().

---

The documentation for this class was generated from the following file:

• generic_shared.hpp