jubatus::core::unlearner::random_unlearner Class Reference

#include <random_unlearner.hpp>

Inheritance diagram for jubatus::core::unlearner::random_unlearner:

Collaboration diagram for jubatus::core::unlearner::random_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
	random_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 Attributes
jubatus::util::data::unordered_map< std::string, size_t >	id_map_
std::vector< std::string >	ids_
size_t	max_size_
jubatus::util::math::random::mtrand	mtr_

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 33 of file random_unlearner.hpp.

Constructor & Destructor Documentation

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

explicit

Definition at line 27 of file random_unlearner.cpp.

References id_map_, ids_, JUBATUS_EXCEPTION, jubatus::core::unlearner::random_unlearner::config::max_size, max_size_, mtr_, and jubatus::core::unlearner::random_unlearner::config::seed.

    : 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"));
  }
  if (conf.seed) {
    if (*conf.seed < 0 || std::numeric_limits<uint32_t>::max() < *conf.seed) {
      throw JUBATUS_EXCEPTION(
          common::config_exception() << common::exception::error_message(
              "unlearner seed must be within unsigned 32 bit integer"));
    }
    mtr_ = jubatus::util::math::random::mtrand(*conf.seed);
  }
  id_map_.reserve(max_size_);
  ids_.reserve(max_size_);
}

Member Function Documentation

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

virtual

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

Definition at line 46 of file random_unlearner.cpp.

                                                    {
  return true;
}

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

inlinevirtual

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

Definition at line 49 of file random_unlearner.hpp.

References id_map_, and ids_.

               {
    id_map_.clear();
    ids_.clear();
  }

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

virtual

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

Definition at line 92 of file random_unlearner.cpp.

References id_map_.

                                                                 {
  return id_map_.count(id) > 0;
}

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

virtual

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

Definition at line 73 of file random_unlearner.cpp.

References id_map_, and ids_.

                                                 {
  if (id_map_.count(id) == 0) {
    return false;
  }

  const size_t id_pos = id_map_[id];
  id_map_.erase(id);

  // Overwrite the ID with the last element to avoid calling erase to vector.
  const std::string back_id = ids_.back();
  ids_.pop_back();
  if (id != back_id) {
    ids_[id_pos] = back_id;
    id_map_[back_id] = id_pos;
  }

  return true;
}

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

virtual

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

Definition at line 50 of file random_unlearner.cpp.

References id_map_, ids_, max_size_, mtr_, and jubatus::core::unlearner::unlearner_base::unlearn().

                                                {
  if (id_map_.count(id) > 0) {
    return true;
  }

  size_t new_id_pos = -1;
  if (id_map_.size() < max_size_) {
    // Just add new ID to the ID set.
    ids_.push_back(id);
    new_id_pos = ids_.size() - 1;
  } else {
    // Need to unlearn the old entry and replace it with new one.
    new_id_pos = mtr_(id_map_.size());
    const std::string old_id = ids_[new_id_pos];
    unlearn(old_id);
    id_map_.erase(old_id);
    ids_[new_id_pos] = id;
  }
  id_map_.insert(std::make_pair(id, new_id_pos));

  return true;
}

Here is the call graph for this function:

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

inlinevirtual

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

Definition at line 45 of file random_unlearner.hpp.

                         {
    return "random_unlearner";
  }

Member Data Documentation

jubatus::util::data::unordered_map<std::string, size_t> jubatus::core::unlearner::random_unlearner::id_map_

private

Map of ID and its position in ids_.

Definition at line 65 of file random_unlearner.hpp.

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

std::vector<std::string> jubatus::core::unlearner::random_unlearner::ids_

private

Unlearner ID set.

Definition at line 70 of file random_unlearner.hpp.

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

size_t jubatus::core::unlearner::random_unlearner::max_size_

private

Maximum size to be hold.

Definition at line 75 of file random_unlearner.hpp.

Referenced by random_unlearner(), and touch().

jubatus::util::math::random::mtrand jubatus::core::unlearner::random_unlearner::mtr_

private

Random number generator.

Definition at line 80 of file random_unlearner.hpp.

Referenced by random_unlearner(), and touch().

---

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

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