Skip to content

Update README.rst #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yaroverg wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.rst #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,18 @@ From version ``0.2.0``, ``base62`` supports ``bytes`` array encoding as well.
Some may be inclined to assume that they both take ``bytes`` types as input
due to their namings. However, ``encodebytes()`` takes ``bytes`` types
whereas ``decodebytes()`` takes ``str`` types as an input. They are intended
to be commutative, so that a *roundtrip* between both functions yields the
to be inverses, so that a *roundtrip* between both functions yields the
original value.

Formally speaking, we say function *f* and *g* commute if *f∘g* = *g∘f* where
*f(g(x))* = *(f∘g)(x)*.
Formally speaking, we say functions *f* and *g* are inverses if *f∘g* is the
identity function on the domain of *g* and *g∘f* is the identity function
on the domain of *f*. Where *(f∘g)(x)* = *f(g(x))* and the identity function
returns the original input: *id(x) = x*.

Therefore, we may expect the following relationships:

* ``value == encodebytes(decodebytes(value))``
* ``value == decodebytes(encodebytes(value))``
* ``value_str == encodebytes(decodebytes(value_str))``
* ``value_bytes == decodebytes(encodebytes(value_bytes))``

Tests
=====
Expand Down