presage  0.9.1
suggestion.h
Go to the documentation of this file.
1 
2 /******************************************************
3  * Presage, an extensible predictive text entry system
4  * ---------------------------------------------------
5  *
6  * Copyright (C) 2008 Matteo Vescovi <matteo.vescovi@yahoo.co.uk>
7 
8  This program is free software; you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation; either version 2 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License along
19  with this program; if not, write to the Free Software Foundation, Inc.,
20  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  *
22  **********(*)*/
23 
24 
25 #ifndef PRESAGE_SUGGESTION
26 #define PRESAGE_SUGGESTION
27 
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31 
32 #include <iostream>
33 #include <sstream>
34 #include <string>
35 
36 #include "../presageException.h"
37 
50 class Suggestion {
51  friend std::ostream &operator<<( std::ostream &, const Suggestion & );
52 public:
53  Suggestion(std::string="",double=0.0);
54  ~Suggestion();
55 
56  bool operator== (const Suggestion&) const;
57  bool operator!= (const Suggestion&) const;
58  bool operator< (const Suggestion&) const;
59 
60  std::string getWord() const;
61  double getProbability() const;
62  void setWord(std::string);
63  void setProbability(double);
66  std::string toString() const;
67 
68  static const double MIN_PROBABILITY;
69  static const double MAX_PROBABILITY;
70 
71  class SuggestionException : public PresageException {
72  public:
73  SuggestionException(presage_error_code_t code, const std::string& msg) throw() : PresageException(code, msg) { }
74  virtual ~SuggestionException() throw() { }
75 
76  private:
78 
79  };
80 
81 private:
82  std::string word;
83  double probability;
84 
85 };
86 
87 
88 
89 #endif // PRESAGE_SUGGESTION
Suggestion::SuggestionException
Definition: suggestion.h:91
Suggestion
Definition: suggestion.h:50
Suggestion::operator!=
bool operator!=(const Suggestion &) const
Definition: suggestion.cpp:47
presage_error_code_t
presage_error_code_t
Definition: presageException.h:32
Suggestion::toString
std::string toString() const
Definition: suggestion.cpp:95
PRESAGE_ERROR
@ PRESAGE_ERROR
Definition: presageException.h:55
Suggestion::operator==
bool operator==(const Suggestion &) const
Definition: suggestion.cpp:39
Suggestion::word
std::string word
Definition: suggestion.h:102
Suggestion::setWord
void setWord(std::string)
Definition: suggestion.cpp:74
PresageException::code
virtual const presage_error_code_t code() const
Definition: presageException.h:86
Suggestion::probability
double probability
Definition: suggestion.h:103
PresageException::PresageException
PresageException(presage_error_code_t code, const std::string &msg)
Definition: presageException.h:69
Suggestion::~Suggestion
~Suggestion()
Definition: suggestion.cpp:36
Suggestion::MAX_PROBABILITY
static const double MAX_PROBABILITY
Definition: suggestion.h:89
Suggestion::getWord
std::string getWord() const
Definition: suggestion.cpp:64
Suggestion::operator<
bool operator<(const Suggestion &) const
Definition: suggestion.cpp:52
Suggestion::operator<<
friend std::ostream & operator<<(std::ostream &, const Suggestion &)
Definition: suggestion.cpp:103
Suggestion::SuggestionException::SuggestionException
SuggestionException()
Definition: suggestion.h:97
PresageException
Definition: presageException.h:67
Suggestion::MIN_PROBABILITY
static const double MIN_PROBABILITY
Definition: suggestion.h:88
Suggestion::setProbability
void setProbability(double)
Definition: suggestion.cpp:79
Suggestion::Suggestion
Suggestion(std::string="", double=0.0)
Definition: suggestion.cpp:30
Suggestion::SuggestionException::~SuggestionException
virtual ~SuggestionException()
Definition: suggestion.h:94
Suggestion::getProbability
double getProbability() const
Definition: suggestion.cpp:69