suggestion.h
Go to the documentation of this file.
/******************************************************
* Presage, an extensible predictive text entry system
* ---------------------------------------------------
*
* Copyright (C) 2008 Matteo Vescovi <matteo.vescovi@yahoo.co.uk>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
**********(*)*/
#ifndef PRESAGE_SUGGESTION
#define PRESAGE_SUGGESTION
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <iostream>
#include <sstream>
#include <string>
#include "../presageException.h"
class Suggestion {
friend std::ostream &operator<<( std::ostream &, const Suggestion & );
public:
Suggestion(std::string="",double=0.0);
~Suggestion();
bool operator== (const Suggestion&) const;
bool operator!= (const Suggestion&) const;
bool operator< (const Suggestion&) const;
std::string getWord() const;
double getProbability() const;
void setWord(std::string);
void setProbability(double);
std::string toString() const;
static const double MIN_PROBABILITY;
static const double MAX_PROBABILITY;
class SuggestionException : public PresageException {
public:
SuggestionException(presage_error_code_t code, const std::string& msg) throw() : PresageException(code, msg) { }
virtual ~SuggestionException() throw() { }
private:
SuggestionException() throw() : PresageException(PRESAGE_ERROR, "") {};
};
private:
std::string word;
double probability;
};
#endif // PRESAGE_SUGGESTION
Suggestion
Definition: suggestion.h:49
Suggestion::operator!=
bool operator!=(const Suggestion &) const
Definition: suggestion.cpp:46
presage_error_code_t
presage_error_code_t
Definition: presageException.h:31
Suggestion::toString
std::string toString() const
Definition: suggestion.cpp:94
PRESAGE_ERROR
Definition: presageException.h:53
Suggestion::operator==
bool operator==(const Suggestion &) const
Definition: suggestion.cpp:38
Suggestion::word
std::string word
Definition: suggestion.h:100
Suggestion::setWord
void setWord(std::string)
Definition: suggestion.cpp:73
PresageException::code
virtual const presage_error_code_t code() const
Definition: presageException.h:85
Suggestion::probability
double probability
Definition: suggestion.h:101
PresageException::PresageException
PresageException(presage_error_code_t code, const std::string &msg)
Definition: presageException.h:68
Suggestion::~Suggestion
~Suggestion()
Definition: suggestion.cpp:35
Suggestion::MAX_PROBABILITY
static const double MAX_PROBABILITY
Definition: suggestion.h:87
Suggestion::getWord
std::string getWord() const
Definition: suggestion.cpp:63
Suggestion::operator<
bool operator<(const Suggestion &) const
Definition: suggestion.cpp:51
Suggestion::operator<<
friend std::ostream & operator<<(std::ostream &, const Suggestion &)
Definition: suggestion.cpp:102
Suggestion::SuggestionException::SuggestionException
SuggestionException()
Definition: suggestion.h:95
PresageException
Definition: presageException.h:66
Suggestion::MIN_PROBABILITY
static const double MIN_PROBABILITY
Definition: suggestion.h:86
Suggestion::setProbability
void setProbability(double)
Definition: suggestion.cpp:78
Suggestion::Suggestion
Suggestion(std::string="", double=0.0)
Definition: suggestion.cpp:29
Suggestion::SuggestionException::~SuggestionException
virtual ~SuggestionException()
Definition: suggestion.h:92
Suggestion::getProbability
double getProbability() const
Definition: suggestion.cpp:68