lensの演算子と等価な関数の対応表

　viewと(^.)のように、
型は違えど（flipされていたり、一般化されていても）同じことをする
関数と演算子があります。

　よくreviewとpreviewを間違えて覚えてたりして困るので、
これをここにまとめておきます。

　なおここでの「等価」という言葉は「QuickCheckで両者の比較したら同じものが返ってくることをテストできるだろう」程度の意味合いで用いています。

演算子	関数	役割
(^.) :: s -> Getting a s a -> a	view :: MonadReader s m => Getting a s a -> m a	Lens型向けのgetter
(^?) :: s -> Getting (First a) s a -> Maybe a	preview :: MonadReader s m => Getting (First a) s a -> m (Maybe a)	Prism型向けのgetter
(.~) :: ASetter s t a b -> b -> s -> t	set :: ASetter s t a b -> b -> s -> t	Lens型向けのsetter
(?~) :: ASetter s t a (Maybe b) -> b -> s -> t	対応なし	直和型に対するsetter*？？*
(#) :: AReview t b -> b -> t	review :: MonadReader b m => AReview t b -> m t	bにPrism (AReview) を適用してtを得る

使用例

　以下ではこれのimportを省略します。

import Control.Lens
import Data.Void (Void)

^.

-- _1はLens
main :: IO ()
main = print $ ('a', Right 10) ^. _1
-- {output}
-- 'a'

^?

-- _RightはPrism
main :: IO ()
main = print $ ('a', Right 10) ^? _2 . _Right
-- {output}
-- Just 10

-- _LeftはPrism
main :: IO ()
main = print $ ('a', Right 10 :: Either Void Int) ^? _2 . _Left
-- {output}
-- Nothing

.~

main :: IO ()
main = print $ ('a', Right 10 :: Either Void Int) & _1 .~ 20
-- {output}
-- (20,Right 10)

.~はPrismにも使えます。

main :: IO ()
main = print $ ('a', Right 10 :: Either Void Int) & _2 . _Right .~ 20
-- {output}
-- ('a',Right 20)

-- 評価されないから恥ずかしくないもん！
dummy :: Void
dummy = undefined

-- _Leftの照合に失敗するので、変更が起こらない
main :: IO ()
main = print $ ('a', Right 10 :: Either Void Int) & _2 . _Left .~ dummy
-- {output}
-- ('a',Right 10)

?~

main :: IO ()
main = print $ ('a', Right 10) & _2 ?~ 20
-- {output}
-- ('a',Just 20)

main :: IO ()
main = print $ ('a', Just 10) & _2 ?~ 20
-- {output}
-- ('a',Just 20)

main :: IO ()
main = print $ ('a', Right 10 :: Either Void Int) & _1 ?~ 20
-- {output}
-- ('a',Just 20)

余談

関数の方の使いどころ

　演算子でなく関数を使った方が綺麗に書けるパターンとして、以下のように
Functorの内側にアクセッサを適用したいというものがあります。

{-# LANGUAGE TemplateHaskell #-}

import Control.Lens

makeLensesFor [("runIdentity", "_Identity")] ''Identity

x :: Identity (Identity Int)
x = Identity $ Identity 10

-- ここ
z :: Identity Int
z = x <&> view _Identity

main :: IO ()
main = print z