[#GCSFilter]
= GCSFilter
:mrdocs:

This implements a Golomb‐coded set as defined in BIP 158. It is a compact, probabilistic data structure for testing set membership.

== Synopsis

Declared in `<blockfilter.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class GCSFilter;
----

== Types

[cols="1,4"]
|===
| Name| Description
| xref:GCSFilter/Params.adoc[`Params`] 
| Parameters controlling the SipHash keys and Golomb‐Rice encoding of a filter.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:GCSFilter/Element.adoc[`Element`] 
| A single set element, stored as a raw byte sequence.
| xref:GCSFilter/ElementSet.adoc[`ElementSet`] 
| A collection of unique elements used to build or query a filter.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:GCSFilter/2constructor-0a.adoc[`GCSFilter`]         [.small]#[constructor]#
| Constructors
| xref:GCSFilter/GetEncoded.adoc[`GetEncoded`] 
| Returns the serialized filter contents.
| xref:GCSFilter/GetN.adoc[`GetN`] 
| Returns the number of elements in the filter.
| xref:GCSFilter/GetParams.adoc[`GetParams`] 
| Returns the parameters used to build the filter.
| xref:GCSFilter/Match.adoc[`Match`] 
| Checks if the element may be in the set. False positives are possible with probability 1/M.
| xref:GCSFilter/MatchAny.adoc[`MatchAny`] 
| Checks if any of the given elements may be in the set. False positives are possible with probability 1/M per element checked. This is more efficient that checking Match on multiple elements separately.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#