jubatus::core::unlearner::lru_unlearner Class Reference

#include <lru_unlearner.hpp>

Inheritance diagram for jubatus::core::unlearner::lru_unlearner:

Collaboration diagram for jubatus::core::unlearner::lru_unlearner:

Classes
struct	config

Public Member Functions
bool	can_touch (const std::string &id)
void	clear ()
bool	exists_in_memory (const std::string &id) const
	lru_unlearner (const config &conf)
bool	remove (const std::string &id)
bool	touch (const std::string &id)
std::string	type () const
Public Member Functions inherited from jubatus::core::unlearner::unlearner_base
void	set_callback (const unlearning_callback &callback)
virtual	~unlearner_base ()

Private Types
typedef jubatus::util::data::unordered_map< std::string, lru::iterator >	entry_map
typedef std::list< std::string >	lru

Private Member Functions
void	rebuild_entry_map ()

Private Attributes
entry_map	entry_map_
lru	lru_
size_t	max_size_
jubatus::util::data::unordered_set< std::string >	sticky_ids_
jubatus::util::lang::shared_ptr< jubatus::core::fv_converter::key_matcher >	sticky_matcher_

Additional Inherited Members
Protected Member Functions inherited from jubatus::core::unlearner::unlearner_base
void	unlearn (const std::string &id) const

Detailed Description

Definition at line 38 of file lru_unlearner.hpp.

Member Typedef Documentation

typedef jubatus::util::data::unordered_map<std::string, lru::iterator> jubatus::core::unlearner::lru_unlearner::entry_map

private

Definition at line 70 of file lru_unlearner.hpp.

typedef std::list<std::string> jubatus::core::unlearner::lru_unlearner::lru

private

Definition at line 68 of file lru_unlearner.hpp.

Constructor & Destructor Documentation

jubatus::core::unlearner::lru_unlearner::lru_unlearner ( const config &  conf )

explicit

Definition at line 34 of file lru_unlearner.cpp.

References jubatus::core::fv_converter::key_matcher_factory::create_matcher(), entry_map_, JUBATUS_EXCEPTION, jubatus::core::unlearner::lru_unlearner::config::max_size, max_size_, sticky_matcher_, and jubatus::core::unlearner::lru_unlearner::config::sticky_pattern.

    : max_size_(conf.max_size) {
  if (conf.max_size <= 0) {
    throw JUBATUS_EXCEPTION(
        common::config_exception() << common::exception::error_message(
            "max_size must be a positive integer"));
  }
  entry_map_.reserve(max_size_);

  if (conf.sticky_pattern) {
    key_matcher_factory f;
    sticky_matcher_ = f.create_matcher(*conf.sticky_pattern);
  }
}

Here is the call graph for this function:

Member Function Documentation

bool jubatus::core::unlearner::lru_unlearner::can_touch ( const std::string &  id )

virtual

Implements jubatus::core::unlearner::unlearner_base.

Definition at line 49 of file lru_unlearner.cpp.

References exists_in_memory(), max_size_, and sticky_ids_.

                                                 {
  return (exists_in_memory(id) || sticky_ids_.size() < max_size_);
}

Here is the call graph for this function:

void jubatus::core::unlearner::lru_unlearner::clear ( )

inlinevirtual

Implements jubatus::core::unlearner::unlearner_base.

Definition at line 54 of file lru_unlearner.hpp.

References entry_map_, lru_, and sticky_ids_.

               {
    lru_.clear();
    entry_map_.clear();
    sticky_ids_.clear();
  }

bool jubatus::core::unlearner::lru_unlearner::exists_in_memory ( const std::string &  id ) const

virtual

Implements jubatus::core::unlearner::unlearner_base.

Definition at line 125 of file lru_unlearner.cpp.

References entry_map_, and sticky_ids_.

Referenced by can_touch().

                                                              {
  return entry_map_.count(id) > 0 || sticky_ids_.count(id) > 0;
}

Here is the caller graph for this function:

void jubatus::core::unlearner::lru_unlearner::rebuild_entry_map ( )

private

Definition at line 131 of file lru_unlearner.cpp.

References entry_map_, and lru_.

                                      {
  entry_map_.clear();
  for (lru::iterator it = lru_.begin(); it != lru_.end(); ++it) {
    entry_map_[*it] = it;
  }
}

bool jubatus::core::unlearner::lru_unlearner::remove ( const std::string &  id )

virtual

Implements jubatus::core::unlearner::unlearner_base.

Definition at line 102 of file lru_unlearner.cpp.

References entry_map_, lru_, and sticky_ids_.

                                              {
  // Try to erase from non-sticky ID.
  {
    entry_map::iterator it = entry_map_.find(id);
    if (it != entry_map_.end()) {
      lru_.erase(it->second);
      entry_map_.erase(it);
      return true;
    }
  }

  // Try to erase from sticky ID.
  {
    unordered_set<std::string>::iterator it = sticky_ids_.find(id);
    if (it != sticky_ids_.end()) {
      sticky_ids_.erase(it);
      return true;
    }
  }

  return false;
}

bool jubatus::core::unlearner::lru_unlearner::touch ( const std::string &  id )

virtual

Implements jubatus::core::unlearner::unlearner_base.

Definition at line 53 of file lru_unlearner.cpp.

References entry_map_, lru_, max_size_, sticky_ids_, sticky_matcher_, and jubatus::core::unlearner::unlearner_base::unlearn().

                                             {
  // When sticky pattern is specified, unlearner excludes IDs matching
  // the pattern from unlearning.
  bool is_sticky = sticky_matcher_ && sticky_matcher_->match(id);

  if (is_sticky) {
    unordered_set<std::string>::const_iterator it = sticky_ids_.find(id);
    if (it != sticky_ids_.end()) {
      // Sticky ID that is already on memory; nothing to do.
      return true;
    }
  } else {
    entry_map::iterator it = entry_map_.find(id);
    if (it != entry_map_.end()) {
      // Non-sticky ID that is already on memory; mark the ID
      // as most recently used.
      lru_.push_front(id);
      lru_.erase(it->second);
      it->second = lru_.begin();
      return true;
    }
  }

  // Touched ID is not on memory; need to secure a space for it.
  if ((entry_map_.size() + sticky_ids_.size()) >= max_size_) {
    // No more space; sticky_ids_ is the list of IDs that cannot be
    // unlearned, so try to unlearn from entry_map_.
    if (entry_map_.size() == 0) {
      // entry_map_ is empty; nothing can be unlearned.
      return false;
    }

    // Unlearn the least recently used entry.
    unlearn(lru_.back());
    entry_map_.erase(lru_.back());
    lru_.pop_back();
  }

  // Register the new ID.
  if (is_sticky) {
    sticky_ids_.insert(id);
  } else {
    lru_.push_front(id);
    entry_map_[id] = lru_.begin();
  }

  return true;
}

Here is the call graph for this function:

std::string jubatus::core::unlearner::lru_unlearner::type ( ) const

inlinevirtual

Implements jubatus::core::unlearner::unlearner_base.

Definition at line 50 of file lru_unlearner.hpp.

                         {
    return "lru_unlearner";
  }

Member Data Documentation

entry_map jubatus::core::unlearner::lru_unlearner::entry_map_

private

Definition at line 75 of file lru_unlearner.hpp.

Referenced by clear(), exists_in_memory(), lru_unlearner(), rebuild_entry_map(), remove(), and touch().

lru jubatus::core::unlearner::lru_unlearner::lru_

private

Definition at line 74 of file lru_unlearner.hpp.

Referenced by clear(), rebuild_entry_map(), remove(), and touch().

size_t jubatus::core::unlearner::lru_unlearner::max_size_

private

Definition at line 77 of file lru_unlearner.hpp.

Referenced by can_touch(), lru_unlearner(), and touch().

jubatus::util::data::unordered_set<std::string> jubatus::core::unlearner::lru_unlearner::sticky_ids_

private

Definition at line 76 of file lru_unlearner.hpp.

Referenced by can_touch(), clear(), exists_in_memory(), remove(), and touch().

jubatus::util::lang::shared_ptr<jubatus::core::fv_converter::key_matcher> jubatus::core::unlearner::lru_unlearner::sticky_matcher_

private

Definition at line 79 of file lru_unlearner.hpp.

Referenced by lru_unlearner(), and touch().

---

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

• jubatus/core/unlearner/lru_unlearner.hpp
• jubatus/core/unlearner/lru_unlearner.cpp