Struct ReferenceKernel 

pub struct ReferenceKernel<N: FromPrimitive = f32> { /* private fields */ }

A reference implementation of the Kernel trait, copied verbatim from the officially-endorsed implementation by darwinium-com.

Trait Implementations

impl<N: Default + FromPrimitive> Default for ReferenceKernel<N>

fn default() -> ReferenceKernel<N>

Returns the “default value” for a type.

impl Kernel for ReferenceKernel<f32>

Available on crate features std only.

type Buffer1WidthX = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B1>, B1>, B1>, B1>

The width of the first stage (compression) buffer.

type Buffer1LengthY = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B1>, B1>, B1>, B1>

The length of the first stage (compression) buffer.

type InternalFloat = f32

The internal floating point type used for intermediate calculations.

type InputDimension = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>, B0>, B0>, B0>

The width and height of the input image.

type OutputDimension = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

The width and height of the output hash.

type RequiredHardwareFeature = Term

The hardware features required to run this kernel

type Ident = &'static str

Identification token.

fn ident(&self) -> Self::Ident

Return an identification of the kernel. For composite kernels that route to multiple kernels, report the kernel that would be executed.

fn adjust_quality(input: Self::InternalFloat) -> f32

Adjust the quality metric to be between 0 and 1.

fn dct2d( &mut self, buffer: &GenericArray<GenericArray<f32, Self::Buffer1WidthX>, Self::Buffer1LengthY>, tmp_row_buffer: &mut GenericArray<f32, Self::Buffer1WidthX>, output: &mut GenericArray<GenericArray<f32, U16>, U16>, )

Apply a 2D DCT-II transformation to the input buffer write the result to the output buffer.

fn sum_of_gradients( &mut self, input: &GenericArray<GenericArray<Self::InternalFloat, U16>, U16>, ) -> Self::InternalFloat

Compute the sum of gradients of the input buffer in both horizontal and vertical directions.

fn quantize( &mut self, input: &GenericArray<GenericArray<f32, U16>, U16>, threshold: &mut Self::InternalFloat, output: &mut GenericArray<GenericArray<u8, U2>, U16>, )

Convert input to binary by thresholding at median

fn jarosz_compress( &mut self, buffer: &GenericArray<GenericArray<f32, U512>, U512>, output: &mut GenericArray<GenericArray<f32, Self::Buffer1WidthX>, Self::Buffer1LengthY>, )

Apply a tent-filter average to every 8x8 sub-block of the input buffer and write the result of each sub-block to the output buffer.

fn cvt_rgb8_to_luma8f<const R_COEFF: u32, const G_COEFF: u32, const B_COEFF: u32>( &mut self, input: &GenericArray<GenericArray<u8, U3>, Self::InputDimension>, output: &mut GenericArray<f32, Self::InputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Convert one row of input from RGB8 to LUMA8 floating point.

fn cvt_rgba8_to_luma8f<const R_COEFF: u32, const G_COEFF: u32, const B_COEFF: u32>( &mut self, input: &GenericArray<GenericArray<u8, U4>, Self::InputDimension>, output: &mut GenericArray<f32, Self::InputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Convert RGBA8 to LUMA8.

fn pdqf_t( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Transpose a PDQF matrix in place. Output is equivalent to PDQF(t(image)).

fn pdqf_negate_alt_cols<const NEGATE: bool>( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Negate alternative columns of PDQF matrix in place. Equivalent to PDQF(flop(image)).

fn pdqf_negate_alt_rows<const NEGATE: bool>( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Negate alternative rows of PDQF matrix in place. Equivalent to PDQF(flip(image)).

fn pdqf_negate_off_diagonals( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

Negate off-diagonals of PDQF matrix in place. Equivalent to PDQF(rotate180(image)).

fn required_hardware_features_met() -> bool

Shorthand to <<K as Kernel>::RequiredHardwareFeature as EvaluateHardwareFeature>::met_runtime()

impl Kernel for ReferenceKernel<f64>

Available on crate features std only.

type Buffer1WidthX = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B1>, B1>, B1>, B1>

The width of the first stage (compression) buffer.

type Buffer1LengthY = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B1>, B1>, B1>, B1>

The length of the first stage (compression) buffer.

type InternalFloat = f64

The internal floating point type used for intermediate calculations.

type InputDimension = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>, B0>, B0>, B0>

The width and height of the input image.

type OutputDimension = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

The width and height of the output hash.

type RequiredHardwareFeature = Term

The hardware features required to run this kernel

type Ident = &'static str

Identification token.

fn ident(&self) -> Self::Ident

Return an identification of the kernel. For composite kernels that route to multiple kernels, report the kernel that would be executed.

fn adjust_quality(input: Self::InternalFloat) -> f32

Adjust the quality metric to be between 0 and 1.

fn dct2d( &mut self, buffer: &GenericArray<GenericArray<f64, Self::Buffer1WidthX>, Self::Buffer1LengthY>, tmp_row_buffer: &mut GenericArray<f64, Self::Buffer1WidthX>, output: &mut GenericArray<GenericArray<f64, U16>, U16>, )

Apply a 2D DCT-II transformation to the input buffer write the result to the output buffer.

fn sum_of_gradients( &mut self, input: &GenericArray<GenericArray<Self::InternalFloat, U16>, U16>, ) -> Self::InternalFloat

Compute the sum of gradients of the input buffer in both horizontal and vertical directions.

fn quantize( &mut self, input: &GenericArray<GenericArray<f64, U16>, U16>, threshold: &mut Self::InternalFloat, output: &mut GenericArray<GenericArray<u8, U2>, U16>, )

Convert input to binary by thresholding at median

fn jarosz_compress( &mut self, buffer: &GenericArray<GenericArray<f32, U512>, U512>, output: &mut GenericArray<GenericArray<f64, Self::Buffer1WidthX>, Self::Buffer1LengthY>, )

Apply a tent-filter average to every 8x8 sub-block of the input buffer and write the result of each sub-block to the output buffer.

fn cvt_rgb8_to_luma8f<const R_COEFF: u32, const G_COEFF: u32, const B_COEFF: u32>( &mut self, input: &GenericArray<GenericArray<u8, U3>, Self::InputDimension>, output: &mut GenericArray<f32, Self::InputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Convert one row of input from RGB8 to LUMA8 floating point.

fn cvt_rgba8_to_luma8f<const R_COEFF: u32, const G_COEFF: u32, const B_COEFF: u32>( &mut self, input: &GenericArray<GenericArray<u8, U4>, Self::InputDimension>, output: &mut GenericArray<f32, Self::InputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Convert RGBA8 to LUMA8.

fn pdqf_t( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Transpose a PDQF matrix in place. Output is equivalent to PDQF(t(image)).

fn pdqf_negate_alt_cols<const NEGATE: bool>( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Negate alternative columns of PDQF matrix in place. Equivalent to PDQF(flop(image)).

fn pdqf_negate_alt_rows<const NEGATE: bool>( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

where Self::RequiredHardwareFeature: EvaluateHardwareFeature<EnabledStatic = B1>,

Negate alternative rows of PDQF matrix in place. Equivalent to PDQF(flip(image)).

fn pdqf_negate_off_diagonals( &mut self, input: &mut GenericArray<GenericArray<Self::InternalFloat, Self::OutputDimension>, Self::OutputDimension>, )

Negate off-diagonals of PDQF matrix in place. Equivalent to PDQF(rotate180(image)).

fn required_hardware_features_met() -> bool

Shorthand to <<K as Kernel>::RequiredHardwareFeature as EvaluateHardwareFeature>::met_runtime()

impl PreciseKernel for ReferenceKernel<f32>

Available on crate features std only.

impl PreciseKernel for ReferenceKernel<f64>

Available on crate features std only.