Data.Bitraversable

class (Bifunctor t, Bifoldable t) => Bitraversable (t :: Type -> Type -> Type) where Исходный код

Bitraversable идентифицирует бифункциональные структуры данных, элементы которых можно пройти в порядке, выполняя Applicative или Monad действия в каждом элементе и собирая структуру результатов с той же формой.

В отличие от Traversable структур данных, которые имеют один тип элемента, над которым можно выполнить действие, Bitraversable структуры данных имеют два таких типа элементов.

Определение bitraverse должно удовлетворять следующим законам:

Натуральность

bitraverse (t . f) (t . g) ≡ t . bitraverse f g для каждой аппликативной трансформации t

Тождество

bitraverse Identity Identity ≡ Identity

Композиция

Compose . fmap (bitraverse g1 g2) . bitraverse f1 f2 ≡ bitraverse (Compose . fmap g1 . f1) (Compose . fmap g2 . f2)

где аппликативная трансформация — это функция

t :: (Applicative f, Applicative g) => f a -> g a

сохраняющая Applicative операции:

t (pure x) ≡ pure x
t (f <*> x) ≡ t f <*> t x

и тождественный функтор Identity и композиционные функторы Compose из Data.Functor.Identity и Data.Functor.Compose.

Некоторые простые примеры — Either и (,):

instance Bitraversable Either where
  bitraverse f _ (Left x) = Left <$> f x
  bitraverse _ g (Right y) = Right <$> g y

instance Bitraversable (,) where
  bitraverse f g (x, y) = (,) <$> f x <*> g y

Bitraversable связана со своими суперклассами следующим образом:

bimap f g ≡ runIdentity . bitraverse (Identity . f) (Identity . g)
bifoldMap f g ≡ getConst . bitraverse (Const . f) (Const . g)

Они доступны как bimapDefault и bifoldMapDefault соответственно.

Если тип также является экземпляром Traversable, то он должен удовлетворять (с учётом лени):

traverse ≡ bitraverse pure

С тех пор: base-4.10.0.0

bitraverse f g ≡ bisequenceA . bimap f g

>>> bitraverse listToMaybe (find odd) (Left [])
Nothing

>>> bitraverse listToMaybe (find odd) (Left [1, 2, 3])
Just (Left 1)

>>> bitraverse listToMaybe (find odd) (Right [4, 5])
Just (Right 5)

>>> bitraverse listToMaybe (find odd) ([1, 2, 3], [4, 5])
Just (1,5)

>>> bitraverse listToMaybe (find odd) ([], [4, 5])
Nothing

bisequenceA :: (Bitraversable t, Applicative f) => t (f a) (f b) -> f (t a b) Источник

Псевдоним для bisequence.

С версии: base-4.10.0.0

bisequence :: (Bitraversable t, Applicative f) => t (f a) (f b) -> f (t a b) Источник

Последовательно выполняет все действия в структуре, создавая новую структуру с той же формой, используя результаты действий. Для версии, которая игнорирует результаты, см. bisequence_.

bisequence ≡ bitraverse id id

Примеры

>>> bisequence (Just 4, Nothing)
Nothing

>>> bisequence (Just 4, Just 5)
Just (4,5)

>>> bisequence ([1, 2, 3], [4, 5])
[(1,4),(1,5),(2,4),(2,5),(3,4),(3,5)]

С версии: base-4.10.0.0

bimapM :: (Bitraversable t, Applicative f) => (a -> f c) -> (b -> f d) -> t a b -> f (t c d) Источник

Псевдоним для bitraverse.

С версии: base-4.10.0.0

firstA :: (Bitraversable t, Applicative f) => (a -> f c) -> t a b -> f (t c b) Источник

Обрабатывает только первый аргумент.

firstA f ≡ bitraverse f pure

secondA :: (Bitraversable t, Applicative f) => (b -> f c) -> t a b -> f (t a c) Источник

Обрабатывает только второй аргумент.

secondA f ≡ bitraverse pure f

Примеры

>>> secondA (find odd) (Left [])
Just (Left [])

>>> secondA (find odd) (Left [1, 2, 3])
Just (Left [1,2,3])

>>> secondA (find odd) (Right [4, 5])
Just (Right 5)

>>> secondA (find odd) ([1, 2, 3], [4, 5])
Just ([1,2,3],5)

>>> secondA (find odd) ([1,2,3], [4])
Nothing

С версии: base-4.21.0.0

bifor :: (Bitraversable t, Applicative f) => t a b -> (a -> f c) -> (b -> f d) -> f (t c d) Источник

bifor - это bitraverse со структурой в качестве первого аргумента. Для версии, которая игнорирует результаты, см. bifor_.

Примеры

>>> bifor (Left []) listToMaybe (find even)
Nothing

>>> bifor (Left [1, 2, 3]) listToMaybe (find even)
Just (Left 1)

>>> bifor (Right [4, 5]) listToMaybe (find even)
Just (Right 4)

>>> bifor ([1, 2, 3], [4, 5]) listToMaybe (find even)
Just (1,4)

>>> bifor ([], [4, 5]) listToMaybe (find even)
Nothing

С версии: base-4.10.0.0

biforM :: (Bitraversable t, Applicative f) => t a b -> (a -> f c) -> (b -> f d) -> f (t c d) Источник

Псевдоним для bifor.

С версии: base-4.10.0.0

bimapAccumL :: Bitraversable t => (a -> b -> (a, c)) -> (a -> d -> (a, e)) -> a -> t b d -> (a, t c e) Источник

Функция bimapAccumL работает как комбинация bimap и bifoldl; она обрабатывает структуру слева направо, передавая состояние типа a и используя заданные действия для вычисления новых элементов структуры.

Примеры

>>> bimapAccumL (\acc bool -> (acc + 1, show bool)) (\acc string -> (acc * 2, reverse string)) 3 (True, "foo")
(8,("True","oof"))

С версии: base-4.10.0.0

bimapAccumR :: Bitraversable t => (a -> b -> (a, c)) -> (a -> d -> (a, e)) -> a -> t b d -> (a, t c e) Источник

Функция bimapAccumR работает как комбинация bimap и bifoldr; она обрабатывает структуру справа налево, передавая состояние типа a и используя заданные действия для вычисления новых элементов структуры.

Примеры

>>> bimapAccumR (\acc bool -> (acc + 1, show bool)) (\acc string -> (acc * 2, reverse string)) 3 (True, "foo")
(7,("True","oof"))

С версии: base-4.10.0.0

bimapDefault :: Bitraversable t => (a -> b) -> (c -> d) -> t a c -> t b d Источник

Стандартное определение bimap в терминах операций Bitraversable.

bimapDefault f g ≡
     runIdentity . bitraverse (Identity . f) (Identity . g)

С версии: base-4.10.0.0

bifoldMapDefault :: (Bitraversable t, Monoid m) => (a -> m) -> (b -> m) -> t a b -> m Источник

Стандартное определение bifoldMap в терминах операций Bitraversable.

bifoldMapDefault f g ≡
    getConst . bitraverse (Const . f) (Const . g)

С версии: base-4.10.0.0