Struct conllu::graph::Sentence

pub struct Sentence { /* fields omitted */ }

A CoNLL-U dependency graph.

Sentence stores a dependency graph. The nodes in the graph (except the special root node) are tokens that have the fields of the CoNLL-U format. Dependency relations are stored as edges in the graph.

This data structure is a thin wrapper around the petgraph DiGraph data structure that enforces variants such as single-headedness. The into_inner/get_ref methods can be used to unwrap or get a reference to the wrapped graph.

Methods

impl Sentence

pub fn new() -> Self

Construct a new sentence.

The sentence will be constructed such that the first token is the root of the dependency graph:

use conllu::graph::{Node, Sentence};

let sentence = Sentence::new();
assert_eq!(sentence[0], Node::Root);

pub fn comments(&self) -> &[Comment]

pub fn comments_mut(&mut self) -> &mut Vec<Comment>

pub fn get_ref(&self) -> &DiGraph<Node, Edge>

Get a reference to the DiGraph of the sentence.

pub fn into_inner(self) -> DiGraph<Node, Edge>

Unwrap the DiGraph of the sentence.

pub fn iter(&self) -> Iter

Get an iterator over the nodes in the graph.

pub fn iter_mut(&mut self) -> IterMut

Get a mutable iterator over the nodes in the graph.

pub fn push(&mut self, token: Token) -> usize

Add a new token to the graph.

Tokens should always be pushed in sentence order.

Returns the index of the token. The first pushed token has index 1, since index 0 is reserved by the root of the graph.

pub fn dep_graph(&self) -> DepGraph

Get the dependency graph.

pub fn dep_graph_mut(&mut self) -> DepGraphMut

Get the graph mutably.

pub fn len(&self) -> usize

Get the number of nodes in the dependency graph.

This is equal to the number of tokens, plus one root node.

pub fn set_comments(&mut self, comments: impl Into<Vec<Comment>>)

Replace the comments by the given comments.

Returns the old comments that are replaced.

Trait Implementations

impl Clone for Sentence

fn clone(&self) -> Sentence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sentence

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Sentence

fn default() -> Self

Returns the "default value" for a type.

impl Display for Sentence

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Sentence

impl<'a> From<&'a Sentence> for &'a DiGraph<Node, Edge>

fn from(sentence: &'a Sentence) -> Self

Performs the conversion.

impl From<Sentence> for DiGraph<Node, Edge>

fn from(sentence: Sentence) -> Self

Performs the conversion.

impl FromIterator<Token> for Sentence

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Token>, 

Creates a value from an iterator.

impl Index<usize> for Sentence

type Output = Node

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Sentence

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Sentence

type Item = &'a Node

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Sentence

type Item = &'a mut Node

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Sentence> for Sentence

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.