vector-algorithms-0.3.1: Efficient algorithms for vector arrays

Portability Non-portable (bang patterns) Experimental Dan Doel

Data.Vector.Algorithms.Search

Description

This module implements several methods of searching for indicies to insert elements into a sorted array.

Synopsis

# Documentation

binarySearch :: (PrimMonad m, MVector v e, Ord e) => v (PrimState m) e -> e -> m IntSource

Finds an index in a givesn sorted array at which the given element could be inserted while maintaining the sortedness of the array.

binarySearchBy :: (PrimMonad m, MVector v e) => Comparison e -> v (PrimState m) e -> e -> m IntSource

Finds an index in a given array, which must be sorted with respect to the given comparison function, at which the given element could be inserted while preserving the array's sortedness.

binarySearchByBounds :: (PrimMonad m, MVector v e) => Comparison e -> v (PrimState m) e -> e -> Int -> Int -> m IntSource

Given an array sorted with respect to a given comparison function in indices in [l,u), finds an index in [l,u] at which the given element could be inserted while preserving sortedness.

binarySearchL :: (PrimMonad m, MVector v e, Ord e) => v (PrimState m) e -> e -> m IntSource

Finds the lowest index in a given sorted array at which the given element could be inserted while maintaining the sortedness.

binarySearchLBy :: (PrimMonad m, MVector v e) => Comparison e -> v (PrimState m) e -> e -> m IntSource

Finds the lowest index in a given array, which must be sorted with respect to the given comparison function, at which the given element could be inserted while preserving the sortedness.

binarySearchLByBounds :: (PrimMonad m, MVector v e) => Comparison e -> v (PrimState m) e -> e -> Int -> Int -> m IntSource

Given an array sorted with respect to a given comparison function on indices in [l,u), finds the lowest index in [l,u] at which the given element could be inserted while preserving sortedness.

type Comparison e = e -> e -> OrderingSource

A type of comparisons between two values of a given type.