ReadabilityAnalysis.h header

#include <ew/app/ReadabilityAnalysis.h>

Namespace ew::app

Readability struct

struct ew::app::Readability

Readability metrics for a body of prose, based on word, sentence, and (estimated) syllable counts. Flesch Reading Ease runs roughly 0-100, higher being easier; Flesch-Kincaid Grade is the approximate US school grade level needed to read the text. Both are zero for empty text. Syllables are estimated with the standard vowel-group heuristic, so the scores are indicative rather than exact.

Members

int ew::app::Readability::words = 0

Total words counted.

int ew::app::Readability::sentences = 0

Total sentences counted (at least one when there are any words).

int ew::app::Readability::syllables = 0

Total estimated syllables.

double ew::app::Readability::averageWordsPerSentence = 0.0

Mean words per sentence.

double ew::app::Readability::averageSyllablesPerWord = 0.0

Mean estimated syllables per word.

double ew::app::Readability::fleschReadingEase = 0.0

Flesch Reading Ease score (higher is easier).

double ew::app::Readability::fleschKincaidGrade = 0.0

Flesch-Kincaid Grade Level (approximate US grade).

Functions

Readability ew::app::analyzeReadability(const QString &text)

Computes readability metrics for text.

Readability ew::app::manuscriptReadability(const ew::core::Project &project)

Computes readability metrics over the combined bodies of every document in project.