aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/codecs/README.md
diff options
context:
space:
mode:
authorRuslan Kovalev <ruslan.a.kovalev@gmail.com>2022-02-10 16:46:44 +0300
committerDaniil Cherednik <dcherednik@yandex-team.ru>2022-02-10 16:46:44 +0300
commit59e19371de37995fcb36beb16cd6ec030af960bc (patch)
treefa68e36093ebff8b805462e9e6d331fe9d348214 /library/cpp/codecs/README.md
parent89db6fe2fe2c32d2a832ddfeb04e8d078e301084 (diff)
downloadydb-59e19371de37995fcb36beb16cd6ec030af960bc.tar.gz
Restoring authorship annotation for Ruslan Kovalev <ruslan.a.kovalev@gmail.com>. Commit 1 of 2.
Diffstat (limited to 'library/cpp/codecs/README.md')
-rw-r--r--library/cpp/codecs/README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/library/cpp/codecs/README.md b/library/cpp/codecs/README.md
index 42646ccd97..26fa96da59 100644
--- a/library/cpp/codecs/README.md
+++ b/library/cpp/codecs/README.md
@@ -1,8 +1,8 @@
This is a library of compression algorithms with a unified interface and serialization.
See also library/cpp/codecs/static, where a support for statically compiled dictionaries is implemented.
-
+
All algorithms have a common `ICodec` interface (described in codecs.h).
-
+
The `ICodec` interface has the following methods:\
    `virtual ui8 ICodec::Encode (TMemoryRegion, TBuffer&) const;`\
            - Input - memory region. Output - filled buffer and the rest of the last byte, if it was not filled to the end.\
@@ -27,9 +27,9 @@ The `ICodec` interface has the following methods:\
                    For example, it allows you to save information about which combination of codecs was in use (see below).\
    `virtual void Learn(ISequenceReader*);`\
            - The interface for teaching codecs that use information about the distribution of data.
-
+
In addition, the library has a number of utilities that allow a more flexible use of it.
-
+
In the `ICodec` class the following methods are available:\
    `static TCodecPtr GetInstance(const TString& name);`\
            - Creation of a codec instance by a symbolic name\