ldaplusplus::corpus::Document Class Reference

#include <Document.hpp>

Inheritance diagram for ldaplusplus::corpus::Document:

Public Member Functions
virtual const std::shared_ptr< const Corpus >	get_corpus () const =0
virtual const Eigen::VectorXi &	get_words () const =0
template<typename T >
const std::shared_ptr< const T >	get_corpus () const

Detailed Description

A Document is the minimal document needed for any type of LDA implementation.

It is meant to abstract away the source of the document data and the storage type etc.

Member Function Documentation

virtual const std::shared_ptr<const Corpus> ldaplusplus::corpus::Document::get_corpus ( ) const

pure virtual

Returns

The corpus this document belongs to

Implemented in ldaplusplus::corpus::ClassificationDecorator, and ldaplusplus::corpus::EigenDocument.

template<typename T >

const std::shared_ptr<const T> ldaplusplus::corpus::Document::get_corpus ( ) const

inline

Returns

The corpus this documents belongs to after casting it to another pointer type for saving a few keystrokes.

virtual const Eigen::VectorXi& ldaplusplus::corpus::Document::get_words ( ) const

pure virtual

Returns

The bag of words dense vector

Implemented in ldaplusplus::corpus::ClassificationDecorator, and ldaplusplus::corpus::EigenDocument.

---

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

• include/ldaplusplus/Document.hpp