sdhash

type BloomFilter interface {

	// ElemCount returns the number of elements in the BloomFilter.
	ElemCount() uint64

	// MaxElem returns the maximum number of elements that can be present in the BloomFilter.
	MaxElem() uint64

	// BitsPerElem returns the number of bits for each elements of the BloomFilter.
	BitsPerElem() float64

	// WriteToFile serialize the current BloomFilter to a file specified by filename.
	WriteToFile(filename string) error

	// String returns the serialized representation of the BloomFilter.
	String() string
	// contains filtered or unexported methods
}

type Sdbf interface {

	// Name of the of the file or data this Sdbf represents.
	Name() string

	// Size of the hash data for this Sdbf.
	Size() uint64

	// InputSize of the data that the hash was generated from.
	InputSize() uint64

	// FilterCount returns the number of bloom filters count.
	FilterCount() uint32

	// Compare two Sdbf and provide a similarity score ranges between 0 and 100.
	// A score of 0 means that the two files are very different, a score of 100 means that the two files are equals.
	Compare(other Sdbf) int

	// CompareSample compare two Sdbf with sampling and provide a similarity score ranges between 0 and 100.
	// A score of 0 means that the two files are very different, a score of 100 means that the two files are equals.
	CompareSample(other Sdbf, sample uint32) int

	// String returns the encoded Sdbf as a string.
	String() string

	// GetIndex returns the BloomFilter index used during the digesting process.
	GetIndex() BloomFilter

	// GetSearchIndexesResults returns search indexes results.
	// The return value is an array of size == len(searchIndexes), and each elements has another array of length bfCount.
	GetSearchIndexesResults() [][]uint32

	// Fast modify the bloom filter buffer for faster comparison.
	// Warning: the operation overwrite the original buffer.
	Fast()
}

type SdbfFactory interface {

	// WithBlockSize sets the block size for the block mode.
	// The default value of 0 involves in a Sdbf generated in stream mode.
	WithBlockSize(blockSize uint32) SdbfFactory

	// WithInitialIndex sets the initial BloomFilter index.
	// Without setting an initial index the factory creates a new empty BloomFilter.
	WithInitialIndex(initialIndex BloomFilter) SdbfFactory

	// WithSearchIndexes sets a list of BloomFilter which are checked for similarity during digesting process.
	// Without setting a value the searching operation during the digesting process is disabled.
	WithSearchIndexes(searchIndexes []BloomFilter) SdbfFactory

	// WithName sets the name of the Sdbf in the output.
	WithName(name string) SdbfFactory

	// Compute start the digesting process and provide a Sdbf with the result.
	Compute() Sdbf
}