github.com/klaytn/klaytn@v1.12.1/blockchain/bloombits/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2017 The go-ethereum Authors
     3  // This file is part of the go-ethereum library.
     4  //
     5  // The go-ethereum library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Lesser General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // The go-ethereum library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU Lesser General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public License
    16  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from core/bloombits/doc.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package bloombits implements bloom filtering on batches of data.
    23  
    24  Source Files
    25  
    26  Each file provides the following features.
    27    - generator.go : generates the rotated bloom bits to be used for batched filtering.
    28    - matcher.go : creates a stream of potential blocks to inspect for data content through binary AND/OR operations on the bit-streams.
    29    - scheduler.go : handles the scheduling of bloom-filter retrieval operations.
    30  */
    31  package bloombits