var searchIndex = {};
searchIndex["mayda"] = {"doc":"This crate provides three types to compress integer arrays. The design\ngenerally favors decompression speed and the ability to index the\ncompressed array over the compression ratio, on the principle that the \nruntime penalty for using compressed arrays should be as small as possible.","items":[[0,"error","mayda","Defines the `mayda::Error` type. Currently only used for the return types of\nfunctions defined in the `Encodable` trait, but intended to allow for more\ncomplex error handling in the future.",null,null],[3,"Error","mayda::error","The `mayda::Error` type.",null,null],[11,"fmt","","",0,null],[11,"new","","Creates an empty Error object.",0,{"inputs":[{"name":"str"}],"output":{"name":"error"}}],[11,"description","","",0,null],[11,"fmt","","",0,null],[0,"monotone","mayda","`Monotone` encoding of integer arrays. Intended for cases where the entries\nare monotonically increasing. Implemented for all primitive integer types.  ",null,null],[3,"Monotone","mayda::monotone","The type of a monotone encoded integer array. Designed for moderate\ncompression and efficient decoding through the `Encodable` trait, and\nefficient random access through the `Access` trait.",null,null],[11,"partial_cmp","","",1,null],[11,"lt","","",1,null],[11,"le","","",1,null],[11,"gt","","",1,null],[11,"ge","","",1,null],[11,"eq","","",1,null],[11,"ne","","",1,null],[11,"hash","","",1,null],[11,"default","","",1,{"inputs":[],"output":{"name":"monotone"}}],[11,"fmt","","",1,null],[11,"clone","","",1,null],[11,"new","","Creates an empty `Monotone` object.",1,{"inputs":[],"output":{"name":"self"}}],[11,"from_slice","","Creates a `Monotone` object that encodes the slice.",1,null],[11,"is_empty","","Returns true when there are no encoded entries.",1,null],[11,"len","","Returns the number of encoded entries.",1,null],[11,"storage","","Exposes the word storage of the `Monotone` object.",1,null],[11,"mut_storage","","Exposes the mutable word storage of the `Monotone` object.",1,null],[11,"required_width","","Returns the width of the encoded integer type.",1,null],[11,"encode","","",1,null],[11,"decode","","",1,null],[11,"access","","",1,null],[11,"access","","",1,null],[11,"access","","",1,null],[11,"access","","",1,null],[11,"access","","",1,null],[11,"access","","",1,null],[11,"access","","",1,null],[0,"uniform","mayda","`Uniform` encoding of integer arrays. Intended for cases where encoding and\ndecoding speed is desired, or the probability distribution of the entries\nis uniform within certain bounds. Implemented for all primitive integer\ntypes.",null,null],[3,"Uniform","mayda::uniform","The type of a uniform encoded integer array. Designed for moderate\ncompression and efficient decoding through the `Encodable` trait, and\nefficient random access through the `Access` trait.",null,null],[11,"partial_cmp","","",2,null],[11,"lt","","",2,null],[11,"le","","",2,null],[11,"gt","","",2,null],[11,"ge","","",2,null],[11,"eq","","",2,null],[11,"ne","","",2,null],[11,"hash","","",2,null],[11,"default","","",2,{"inputs":[],"output":{"name":"uniform"}}],[11,"fmt","","",2,null],[11,"clone","","",2,null],[11,"new","","Creates an empty `Uniform` object.",2,{"inputs":[],"output":{"name":"self"}}],[11,"from_slice","","Creates a `Uniform` object that encodes the slice.",2,null],[11,"is_empty","","Returns true when there are no encoded entries.",2,null],[11,"len","","Returns the number of encoded entries.",2,null],[11,"storage","","Exposes the word storage of the `Uniform` object.",2,null],[11,"mut_storage","","Exposes the mutable word storage of the `Uniform` object.",2,null],[11,"required_width","","Returns the width of the encoded integer type.",2,null],[11,"encode","","",2,null],[11,"decode","","",2,null],[11,"access","","",2,null],[11,"access","","",2,null],[11,"access","","",2,null],[11,"access","","",2,null],[11,"access","","",2,null],[11,"access","","",2,null],[11,"access","","",2,null],[0,"unimodal","mayda","`Unimodal` encoding of integer arrays. Intended for cases where information\nabout the probability distribution of the entries is not known, and the\npresence of outliers reduces the compression ratio of the other types.\nImplemented for all primitive integer types.",null,null],[3,"Unimodal","mayda::unimodal","The type of a unimodal encoded integer array. Designed for moderate\ncompression and efficient decoding through the `Encodable` trait, and\nefficient random access through the `Access` trait.",null,null],[11,"partial_cmp","","",3,null],[11,"lt","","",3,null],[11,"le","","",3,null],[11,"gt","","",3,null],[11,"ge","","",3,null],[11,"eq","","",3,null],[11,"ne","","",3,null],[11,"hash","","",3,null],[11,"default","","",3,{"inputs":[],"output":{"name":"unimodal"}}],[11,"fmt","","",3,null],[11,"clone","","",3,null],[11,"new","","Creates an empty `Unimodal` object.",3,{"inputs":[],"output":{"name":"self"}}],[11,"from_slice","","Creates a `Unimodal` object that encodes the slice.",3,null],[11,"is_empty","","Returns true when there are no encoded entries.",3,null],[11,"len","","Returns the number of encoded entries.",3,null],[11,"storage","","Exposes the word storage of the `Unimodal` object.",3,null],[11,"mut_storage","","Exposes the mutable word storage of the `Unimodal` object.",3,null],[11,"required_width","","Returns the width of the encoded integer type.",3,null],[11,"encode","","",3,null],[11,"decode","","",3,null],[11,"access","","",3,null],[11,"access","","",3,null],[11,"access","","",3,null],[11,"access","","",3,null],[11,"access","","",3,null],[11,"access","","",3,null],[11,"access","","",3,null],[0,"utility","mayda","Contains constants, enums, traits and functions used by all of the encoding\ntypes provided by the `mayda` crate.",null,null],[5,"words_for_bits","mayda::utility","Returns number of words required to store the given number of bits. A word\nis 32 bits long.",null,{"inputs":[{"name":"u32"}],"output":{"name":"usize"}}],[5,"select_m","","A modified version of the Floyd-Rivest algorithm with fewer comparisions\nand fewer swaps, specialized for the case of slices with length < 500. The\nmodifications may not be known in the literature. Intended to be used to\nfind the median of a block.",null,null],[8,"Bits","","Indicates that the bitwise representation of the type is known to `mayda`.\nIntended to be implemented only for the primitive integer types. Mainly\nused as a bound on the `Encodable` trait.",null,null],[10,"width","","Number of bits in the standard representation.",4,{"inputs":[],"output":{"name":"u32"}}],[10,"bits","","Number of bits required to represent the number in binary. Notice that\n`0.bits() == 0u32` intentionally.",4,null],[8,"Encodable","","Indicates that the type can be encoded and decoded by `mayda`.",null,null],[10,"encode","","Encodes the slice in the `Encodable` object.",5,null],[10,"decode","","Decodes the slice in the `Encodable` object. An encoded vector type must\ngive ownership of the returned value to the caller.",5,null],[8,"Access","","A trait for indexing an encoded vector. Similar to but less convenient than\n`Index`. `Index::index()` returns a reference, but an encoded vector type\nmust give ownership of the returned value to the caller.",null,null],[16,"Output","","The type returned by the access operation.",6,null],[10,"access","","The method for the access `foo.access(bar)` operation.",6,null]],"paths":[[3,"Error"],[3,"Monotone"],[3,"Uniform"],[3,"Unimodal"],[8,"Bits"],[8,"Encodable"],[8,"Access"]]};
initSearch(searchIndex);