Struct Ngrams 

pub struct Ngrams { /* private fields */ }

An n-gram counter for counting n-gram frequencies.

Accumulates n-gram counts from sequences of elements. N-grams do not cross sequence boundaries.

Implementations

impl Ngrams

pub fn new(n: usize, min_n: Option<usize>) -> PyResult<Self>

Create a new empty Ngrams.

Arguments

• n - The n-gram order (1 for unigrams, 2 for bigrams, etc.). Must be >= 1.

pub fn count(&mut self, seq: Vec<String>)

Count n-grams from a single sequence.

Extracts all n-grams of the configured order from the sequence and increments their counts. N-grams do not cross sequence boundaries.

pub fn count_seqs(&mut self, seqs: Vec<Vec<String>>)

Count n-grams from multiple sequences.

Each sequence is treated independently (n-grams do not cross boundaries).

pub fn get(&self, ngram: Vec<String>) -> u64

Return the count for a specific n-gram.

Returns 0 if the n-gram has not been observed.

pub fn most_common( &self, py: Python<'_>, n: Option<usize>, order: Option<usize>, ) -> PyResult<PyObject>

Return the n most common n-grams with their counts.

If n is None, returns all n-grams sorted by count (descending).

pub fn items(&self, py: Python<'_>, order: Option<usize>) -> PyResult<PyObject>

Return all (n-gram, count) pairs.

pub fn total(&self, order: Option<usize>) -> PyResult<u64>

Return the total number of n-gram tokens counted.

pub fn n(&self) -> usize

The n-gram order.

pub fn min_n(&self) -> usize

The minimum n-gram order.

pub fn to_counter( &self, py: Python<'_>, order: Option<usize>, ) -> PyResult<PyObject>

Convert to a Python collections.Counter.

Returns a Counter mapping n-gram tuples to their counts.

pub fn clear(&mut self)

Clear all counts.

Trait Implementations

impl Clone for Ngrams

fn clone(&self) -> Ngrams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for Ngrams

type Target = Ngrams

The Python output type

type Output = Bound<'py, <Ngrams as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for Ngrams

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Ngrams

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Ngrams>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Ngrams> for PyClassImplCollector<Ngrams>

fn new_text_signature(self) -> Option<&'static str>

impl PyClass__add__SlotFragment<Ngrams> for PyClassImplCollector<Ngrams>

unsafe fn __add__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a Ngrams

type Holder = Option<PyRef<'py, Ngrams>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut Ngrams

type Holder = Option<PyRefMut<'py, Ngrams>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Ngrams> for PyClassImplCollector<Ngrams>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Ngrams

const NAME: &'static str = "Ngrams"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for Ngrams