NCBI C++ ToolKit
Enumerations | Functions
+ Collaboration diagram for Binary-distance metrics:

Enumerations

enum  bm::distance_metric {
  bm::COUNT_AND = set_COUNT_AND , bm::COUNT_XOR = set_COUNT_XOR , bm::COUNT_OR = set_COUNT_OR , bm::COUNT_SUB_AB = set_COUNT_SUB_AB ,
  bm::COUNT_SUB_BA = set_COUNT_SUB_BA , bm::COUNT_A = set_COUNT_A , bm::COUNT_B = set_COUNT_B
}
 Distance metrics codes defined for vectors A and B. More...
 

Functions

distance_metric bm::operation2metric (set_operation op) noexcept
 Convert set operation into compatible distance metric. More...
 
template<class BV >
void bm::distance_operation (const BV &bv1, const BV &bv2, distance_metric_descriptor *dmit, distance_metric_descriptor *dmit_end) noexcept
 Distance computing template function. More...
 
template<class BV >
BV::size_type bm::distance_and_operation (const BV &bv1, const BV &bv2) noexcept
 Distance AND computing template function. More...
 
template<class BV >
void bm::distance_operation_any (const BV &bv1, const BV &bv2, distance_metric_descriptor *dmit, distance_metric_descriptor *dmit_end) noexcept
 Distance screening template function. More...
 

Detailed Description

Distance metrics and algorithms to compute binary distances

Enumeration Type Documentation

◆ distance_metric

Distance metrics codes defined for vectors A and B.

Enumerator
COUNT_AND 

(A & B).count()

COUNT_XOR 

(A ^ B).count()

COUNT_OR 

(A | B).count()

COUNT_SUB_AB 

(A - B).count()

COUNT_SUB_BA 

(B - A).count()

COUNT_A 

A.count()

COUNT_B 

B.count()

Definition at line 57 of file bmalgo_impl.h.

Function Documentation

◆ distance_and_operation()

template<class BV >
BV::size_type bm::distance_and_operation ( const BV &  bv1,
const BV &  bv2 
)
noexcept

Distance AND computing template function.

Parameters
bv1- argument bitvector 1 (A)
bv2- argument bitvector 2 (B)

Definition at line 853 of file bmalgo_impl.h.

References BLOCK_ADDR_SAN, bm::combine_count_and_operation_with_block(), FULL_BLOCK_FAKE_ADDR, FULL_SUB_BLOCK_REAL_ADDR, i, bm::min_value(), and bm::set_sub_array_size.

Referenced by bm::count_and().

◆ distance_operation()

template<class BV >
void bm::distance_operation ( const BV &  bv1,
const BV &  bv2,
distance_metric_descriptor dmit,
distance_metric_descriptor dmit_end 
)
noexcept

Distance computing template function.

Function receives two bitvectors and an array of distance metrics (metrics pipeline). Function computes all metrics saves result into corresponding pipeline results (distance_metric_descriptor::result) An important detail is that function reuses metric descriptors, incrementing received values. It allows you to accumulate results from different calls in the pipeline.

Parameters
bv1- argument bitvector 1 (A)
bv2- argument bitvector 2 (B)
dmit- pointer to first element of metric descriptors array Input-Output parameter, receives metric code as input, computation is added to "result" field
dmit_end- pointer to (last+1) element of metric descriptors array

Definition at line 766 of file bmalgo_impl.h.

References bm::combine_count_operation_with_block(), bm::distance_stage(), i, and bm::set_sub_array_size.

Referenced by bm::similarity_batch< SDESCR >::calculate(), bm::count_or(), bm::count_sub(), and bm::count_xor().

◆ distance_operation_any()

template<class BV >
void bm::distance_operation_any ( const BV &  bv1,
const BV &  bv2,
distance_metric_descriptor dmit,
distance_metric_descriptor dmit_end 
)
noexcept

Distance screening template function.

Function receives two bitvectors and an array of distance metrics (metrics pipeline). Function computes possybility of a metric(any bit) saves result into corresponding pipeline results (distance_metric_descriptor::result) An important detail is that function reuses metric descriptors, incrementing received values. It allows you to accumulate results from different calls in the pipeline.

Parameters
bv1- argument bitvector 1 (A)
bv2- argument bitvector 2 (B)
dmit- pointer to first element of metric descriptors array Input-Output parameter, receives metric code as input, computation is added to "result" field
dmit_end- pointer to (last+1) element of metric descriptors array

Definition at line 922 of file bmalgo_impl.h.

References BM_IS_GAP, bm::combine_any_operation_with_block(), bm::distance_stage(), i, bm::distance_metric_descriptor::result, and bm::set_sub_array_size.

Referenced by bm::any_and(), bm::any_or(), bm::any_sub(), and bm::any_xor().

◆ operation2metric()

distance_metric bm::operation2metric ( set_operation  op)
inlinenoexcept

Convert set operation into compatible distance metric.

Definition at line 73 of file bmalgo_impl.h.

References BM_ASSERT, bm::is_const_set_operation(), bm::set_COUNT, and bm::set_COUNT_B.

Referenced by bm::iterator_deserializer< BV, SerialIterator >::deserialize().

Modified on Thu May 23 12:31:15 2024 by modify_doxy.py rev. 669887