Crate vidyut_chandas

vidyut-chandas

A Sanskrit metrical classifier

vidyut-chandas is an experimental classifier for Sanskrit meters.

This crate is under active development as part of the Ambuda project. If you enjoy our work and wish to contribute to it, we encourage you to join our Discord server, where you can meet other Sanskrit programmers and enthusiasts.

An online demo is available here.

• Overview
• Usage

Overview

Sanskrit poetry uses a variety of meters, which specify the syllable patterns that a verse must follow. vidyut-chandas aims to provide a simple API for identifying the meter that a given verse uses.

vidyut-chandas is experimental code and follows in the footsteps of great projects like sanskritmetres and Skrutable.

Usage

(This API is unstable.)

We recommend using vidyut-chandas through our Chandas API:

use vidyut_chandas::{Chandas, MatchType, Vrtta};

let vrttas: Vec<Vrtta> = vec![
    "vasantatilakA\tvrtta\tGGLGLLLGLLGLGG".try_into().unwrap(),
    "mandAkrAntA\tvrtta\tGGGGLLLLLGGLGGLGG".try_into().unwrap(),
    "puzpitAgrA\tvrtta\tLLLLLLGLGLGG/LLLLGLLGLGLGG".try_into().unwrap(),
    "udgatA\tvrtta\tLLGLGLLLGL/LLLLLGLGLG/GLLLLLLGLLG/LLGLGLLLGLGLG".try_into().unwrap()
];
let chandas = Chandas::new(vrttas);

let result = chandas.classify("mAtaH samastajagatAM maDukEwaBAreH");
assert_eq!(result.vrtta().as_ref().unwrap().name(), "vasantatilakA");
assert_eq!(result.match_type(), MatchType::Pada);

Structs

Akshara

A Sanskrit syllable.

Chandas

A metrical classifier.

Jati

Models a jāti, which defines a specific pattern of mātrās (morae).

MatchResult

Describes a result of classifying an input string with Chandas.

Vrtta

Models a vṛtta, which defines a specific pattern of light and heavy syllables.

Enums

MatchType

Describes how a vrtta matches some input.

Weight

The weight of an akshara.