petrovich

package module

v0.0.0-...-3d8202c Latest Latest Go to latest Published: Dec 25, 2022 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/MagicFun1241/petrovich

Links

Open Source Insights

README ¶

Petrovich

Petrovich is the library which inflects Russian names to given grammatical case.

This is the Go port of https://github.com/petrovich.

Installation

go get github.com/striker2000/petrovich

Usage

All functions takes three arguments: name in nominative case, gender and grammatical case.

import "github.com/striker2000/petrovich"

n := petrovich.FirstName("Кузьма", petrovich.Male, petrovich.Genitive)
fmt.Print(n) // "Кузьмы"

n = petrovich.MiddleName("Сергеевич", petrovich.Male, petrovich.Instrumental)
fmt.Print(n) // "Сергеевичем"

n = petrovich.LastName("Петров-Водкин", petrovich.Male, petrovich.Prepositional)
fmt.Print(n) // "Петрове-Водкине"

Valid values for gender are petrovich.Androgynous, petrovich.Male and petrovich.Female.

Full list of grammatical cases is in the table below.

Case	Case (in Russian)	Question (in Russian)
`petrovich.Nominative`	Именительный	Кто?
`petrovich.Genitive`	Родительный	Кого?
`petrovich.Dative`	Дательный	Кому?
`petrovich.Accusative`	Винительный	Кого?
`petrovich.Instrumental`	Творительный	Кем?
`petrovich.Prepositional`	Предложный	О ком?

Documentation ¶

Overview ¶

Package petrovich provides methods to inflect Russian first, last, and middle names.

This is the Go port of https://github.com/petrovich. All implementations use common rules from https://github.com/petrovich/petrovich-rules.

Usage:

n := petrovich.FirstName("Кузьма", petrovich.Male, petrovich.Genitive)
fmt.Print(n) // "Кузьмы"

n = petrovich.LastName("Петров-Водкин", petrovich.Male, petrovich.Prepositional)
fmt.Print(n) // "Петрове-Водкине"

Index ¶

func FirstName(name string, g Gender, c Case) string
func LastName(name string, g Gender, c Case) string
func MiddleName(name string, g Gender, c Case) string
type Case
type Gender

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FirstName ¶

func FirstName(name string, g Gender, c Case) string

FirstName inflects first name depending on the given gender and case.

func LastName ¶

func LastName(name string, g Gender, c Case) string

LastName inflects last name depending on the given gender and case.

func MiddleName ¶

func MiddleName(name string, g Gender, c Case) string

MiddleName inflects middle name depending on the given gender and case.

Types ¶

type Case ¶

type Case int

const (
	Nominative Case = -1 + iota
	Genitive
	Dative
	Accusative
	Instrumental
	Prepositional
)

type Gender ¶

type Gender int

const (
	Androgynous Gender = iota
	Male
	Female
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
rules-generator

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL