SHA_Logger::BinaryLog< IT, T, IsEqualT > Class Template Reference

#include <binary_log.hxx>

Public Member Functions
	~BinaryLog ()

Static Public Member Functions
static const String	GetName ()
static bool	WriteInfo (Writer &writer)
static bool	WriteDoc (Writer &writer)
static bool	WriteSrc (Writer &writer)
static Ostream &	Build (Ostream &os, Options opts, const IT &begin, const IT &end, const T &key)
static Writer &	Build (Writer &writer, Options opts, const IT &begin, const IT &end, const T &key)

Private Member Functions
	BinaryLog (Ostream &os)
BinaryLog	operator= (BinaryLog &)
bool	Write (Options opts, const IT &begin, const IT &end, const T &key)

Static Private Member Functions
static bool	Write (Writer &writer, Options opts, const IT &begin, const IT &end, const T &key)
static bool	WriteParameters (Writer &writer, const IT &begin, const IT &end, const T &key)
static bool	WriteComputation (Writer &writer, const IT &begin, const IT &end, const T &key)

Private Attributes
std::unique_ptr< Stream >	stream
std::unique_ptr< Writer >	writer

Detailed Description

template<typename IT, typename T, typename IsEqualT>
class SHA_Logger::BinaryLog< IT, T, IsEqualT >

Definition at line 35 of file binary_log.hxx.

Constructor & Destructor Documentation

template<typename IT , typename T , typename IsEqualT >

SHA_Logger::BinaryLog< IT, T, IsEqualT >::~BinaryLog ( )

inline

Definition at line 55 of file binary_log.hxx.

{ assert(this->writer->IsComplete()); }

template<typename IT , typename T , typename IsEqualT >

SHA_Logger::BinaryLog< IT, T, IsEqualT >::BinaryLog ( Ostream &  os )

inlineprivate

Definition at line 82 of file binary_log.hxx.

                             : stream(std::unique_ptr<Stream>(new Stream(os))),
                               writer(std::unique_ptr<Writer>(new Writer(*this->stream))) {}

Member Function Documentation

template<typename IT , typename T , typename IsEqualT >

static Ostream& SHA_Logger::BinaryLog< IT, T, IsEqualT >::Build ( Ostream &  os, Options  opts, const IT &  begin, const IT &  end, const T &  key  )

inlinestatic

Instantiate a new json writer using the stream passed as argument, run and write algorithm computation information.

Returns

stream reference filled up with BinaryLog object information, error object information in case of failure.

Definition at line 62 of file binary_log.hxx.

      {
        std::unique_ptr<BinaryLog> builder = std::unique_ptr<BinaryLog>(new BinaryLog(os));
        builder->Write(opts, begin, end, key);

        return os;
      }

template<typename IT , typename T , typename IsEqualT >

static Writer& SHA_Logger::BinaryLog< IT, T, IsEqualT >::Build ( Writer &  writer, Options  opts, const IT &  begin, const IT &  end, const T &  key  )

inlinestatic

Use json writer passed as parameter to write iterator information.

Returns

stream reference filled up with BinaryLog object information, error information in case of failure.

Definition at line 74 of file binary_log.hxx.

      {
        Write(writer, opts, begin, end, key);

        return writer;
      }

template<typename IT , typename T , typename IsEqualT >

static const String SHA_Logger::BinaryLog< IT, T, IsEqualT >::GetName ( )

inlinestatic

Todo:

Use string litteral for JSON description within c++ code eg https://cs.chromium.org/chromium/src/gpu/config/software_rendering_list_json.cc

Definition at line 40 of file binary_log.hxx.

{ return "Binary_Sort"; }

template<typename IT , typename T , typename IsEqualT >

BinaryLog SHA_Logger::BinaryLog< IT, T, IsEqualT >::operator= ( BinaryLog< IT, T, IsEqualT > &  )

inlineprivate

Definition at line 84 of file binary_log.hxx.

{} // Not Implemented

template<typename IT , typename T , typename IsEqualT >

bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::Write ( Options  opts, const IT &  begin, const IT &  end, const T &  key  )

inlineprivate

Definition at line 86 of file binary_log.hxx.

      { return Write(*this->writer, opts, begin, end, key); }

template<typename IT , typename T , typename IsEqualT >

static bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::Write ( Writer &  writer, Options  opts, const IT &  begin, const IT &  end, const T &  key  )

inlinestaticprivate

Definition at line 89 of file binary_log.hxx.

      {
        writer.StartObject();

        // Write description
        Algo_Traits<BinaryLog>::Build(writer, opts);

        // Write parameters
        WriteParameters(writer, begin, end, key);

        // Write computation
        WriteComputation(writer, begin, end, key);

        writer.EndObject();

        return true;
      }

template<typename IT , typename T , typename IsEqualT >

static bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::WriteComputation ( Writer &  writer, const IT &  begin, const IT &  end, const T &  key  )

inlinestaticprivate

Definition at line 120 of file binary_log.hxx.

      {
        // Not part of the logs
        int _lowIdx = 0;

        // Local logged variables
        writer.Key("locals");
        writer.StartArray();
        auto index = Value<int>::BuildValue(writer, "index", -1);
        auto seqSize = Value<int>::BuildValue(writer, "seqSize", static_cast<int>(std::distance(begin, end)));
        auto lowIt = Iterator::BuildIt<IT>(writer, kSeqName, "lowIt", 0, begin);
        auto highIt = Iterator::BuildIt<IT>(writer, kSeqName, "highIt", seqSize + 1, end);
        auto middleIt = Iterator::BuildIt<IT>(writer, kSeqName, "middleIt", seqSize / 2,
          lowIt + seqSize / 2, "Initiate index on the middle element of the sequence");
        writer.EndArray();

        // Log algorithm operations
        writer.Key("logs");
        writer.StartArray();
        Comment::Build(writer, "Start Binary Search", 0);
        while (lowIt < highIt && index < 0)
        {
          if (IsEqualT()(key, *middleIt))
          {
            index = static_cast<int>(std::distance(begin, middleIt));

            Comment::Build(writer, "Found!", 1);
            Operation::Set<int>(writer, "index", index);
            break;
          }
          else if (key > *middleIt)
          {
            lowIt = middleIt + 1;
            _lowIdx += seqSize / 2 + 1;
            seqSize -= seqSize / 2 + 1;

            Comment::Build(writer, "(key > current): search upper sequence.", 1);
            Operation::Set<int>(writer, "lowIt", _lowIdx);
          }
          else
          {
            highIt = middleIt;

            Comment::Build(writer, "(key < current): search lower sequence.", 1);
            Operation::Set<int>(writer, "highIt", seqSize / 2);
            seqSize -= seqSize / 2;
          }

          middleIt = lowIt + seqSize / 2;
          Comment::Build(writer, "Select the middle element of the remaining sequence.", 1);
          Operation::Set<int>(writer, "middleIt", _lowIdx + seqSize / 2);
        }

        // Logs failure
        if (index < 0)
          Comment::Build(writer, "Key not found.", 0);

        Operation::Return<int>(writer, index);
        writer.EndArray();
        return true;
      }

template<typename IT , typename T , typename IsEqualT >

static bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::WriteDoc ( Writer &  writer )

inlinestatic

Write algorithm decription

Todo:

Use string litteral for JSON description within c++ code –> binary_desc.json.hxx

Definition at line 48 of file binary_log.hxx.

{ return true; }

template<typename IT , typename T , typename IsEqualT >

static bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::WriteInfo ( Writer &  writer )

inlinestatic

Write algorithm information

Todo:

Use string litteral for JSON description within c++ code –> binary_desc.json.hxx

Definition at line 44 of file binary_log.hxx.

{ return true; }

template<typename IT , typename T , typename IsEqualT >

static bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::WriteParameters ( Writer &  writer, const IT &  begin, const IT &  end, const T &  key  )

inlinestaticprivate

Definition at line 108 of file binary_log.hxx.

      {
        writer.Key("parameters");
        writer.StartArray();
        Array<IT>::Build(writer, kSeqName, "begin", begin, "end", end);
        Value<T>::Build(writer, "key", key);
        writer.EndArray();

        return true;
      }

template<typename IT , typename T , typename IsEqualT >

static bool SHA_Logger::BinaryLog< IT, T, IsEqualT >::WriteSrc ( Writer &  writer )

inlinestatic

Write algorithm sources

Todo:

Use string litteral for JSON description within c++ code –> binary_desc.json.hxx

Definition at line 52 of file binary_log.hxx.

{ return true; }

Member Data Documentation

template<typename IT , typename T , typename IsEqualT >

std::unique_ptr<Stream> SHA_Logger::BinaryLog< IT, T, IsEqualT >::stream

private

Definition at line 182 of file binary_log.hxx.

template<typename IT , typename T , typename IsEqualT >

std::unique_ptr<Writer> SHA_Logger::BinaryLog< IT, T, IsEqualT >::writer

private

Definition at line 183 of file binary_log.hxx.

---

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

• binary_log.hxx