pointedlist-0.6.1: A zipper-like comonad which works as a list, tracking a position.
Safe HaskellSafe-Inferred
LanguageHaskell98

Data.List.PointedList.Circular

Synopsis

Documentation

data PointedList a Source #

The implementation of the pointed list structure which tracks the current position in the list structure.

Constructors

PointedList 

Fields

Instances

Instances details
Foldable PointedList Source # 
Instance details

Defined in Data.List.PointedList

Methods

fold :: Monoid m => PointedList m -> m Source #

foldMap :: Monoid m => (a -> m) -> PointedList a -> m Source #

foldMap' :: Monoid m => (a -> m) -> PointedList a -> m Source #

foldr :: (a -> b -> b) -> b -> PointedList a -> b Source #

foldr' :: (a -> b -> b) -> b -> PointedList a -> b Source #

foldl :: (b -> a -> b) -> b -> PointedList a -> b Source #

foldl' :: (b -> a -> b) -> b -> PointedList a -> b Source #

foldr1 :: (a -> a -> a) -> PointedList a -> a Source #

foldl1 :: (a -> a -> a) -> PointedList a -> a Source #

toList :: PointedList a -> [a] Source #

null :: PointedList a -> Bool Source #

length :: PointedList a -> Int Source #

elem :: Eq a => a -> PointedList a -> Bool Source #

maximum :: Ord a => PointedList a -> a Source #

minimum :: Ord a => PointedList a -> a Source #

sum :: Num a => PointedList a -> a Source #

product :: Num a => PointedList a -> a Source #

Traversable PointedList Source # 
Instance details

Defined in Data.List.PointedList

Methods

traverse :: Applicative f => (a -> f b) -> PointedList a -> f (PointedList b) Source #

sequenceA :: Applicative f => PointedList (f a) -> f (PointedList a) Source #

mapM :: Monad m => (a -> m b) -> PointedList a -> m (PointedList b) Source #

sequence :: Monad m => PointedList (m a) -> m (PointedList a) Source #

Functor PointedList Source # 
Instance details

Defined in Data.List.PointedList

Methods

fmap :: (a -> b) -> PointedList a -> PointedList b Source #

(<$) :: a -> PointedList b -> PointedList a Source #

Show a => Show (PointedList a) Source # 
Instance details

Defined in Data.List.PointedList

Binary a => Binary (PointedList a) Source # 
Instance details

Defined in Data.List.PointedList

Eq a => Eq (PointedList a) Source # 
Instance details

Defined in Data.List.PointedList

focus :: Functor f => (a -> f a) -> PointedList a -> f (PointedList a) Source #

Lens compatible with Control.Lens.

singleton :: a -> PointedList a Source #

Create a PointedList with a single element.

fromList :: [a] -> Maybe (PointedList a) Source #

Possibly create a Just PointedList if the provided list has at least one element; otherwise, return Nothing.

The provided list's head will be the focus of the list, and the rest of list will follow on the right side.

fromListEnd :: [a] -> Maybe (PointedList a) Source #

Possibly create a Just PointedList if the provided list has at least one element; otherwise, return Nothing.

The provided list's last element will be the focus of the list, following the rest of the list in order, to the left.

replace :: a -> PointedList a -> PointedList a Source #

Replace the focus of the list, retaining the prefix and suffix.

insert :: a -> PointedList a -> PointedList a Source #

An alias for insertRight.

insertLeft :: a -> PointedList a -> PointedList a Source #

Insert an element to the left of the focus, then move the focus to the new element.

insertRight :: a -> PointedList a -> PointedList a Source #

Insert an element to the right of the focus, then move the focus to the new element.

deleteOthers :: PointedList a -> PointedList a Source #

Delete all elements in the list except the focus.

length :: PointedList a -> Int Source #

The length of the list.

positions :: PointedList a -> PointedList (PointedList a) Source #

Create a PointedList of variations of the provided PointedList, in which each element is focused, with the provided PointedList as the focus of the sets.

contextMap :: (PointedList a -> b) -> PointedList a -> PointedList b Source #

Map over the PointedLists created via positions, such that f is called with each element of the list focused in the provided PointedList. An example makes this easier to understand:

contextMap atStart (fromJust $ fromList [1..5])

withFocus :: PointedList a -> PointedList (a, Bool) Source #

Create a PointedList a of (a, Bool), in which the boolean values specify whether the current element has the focus. That is, all of the booleans will be False, except the focused element.

find :: Eq a => a -> PointedList a -> Maybe (PointedList a) Source #

Move the focus to the specified element, if it is present.

Patch with much faster algorithm provided by Runar Bjarnason for version 0.3.2. Improved again by Runar Bjarnason for version 0.3.3 to support infinite lists on both sides of the focus.

index :: PointedList a -> Int Source #

The index of the focus, leftmost is 0.

next :: PointedList a -> PointedList a Source #

Move the focus to the next element in the list. If the last element is currently focused, loop to the first element.

previous :: PointedList a -> PointedList a Source #

Move the focus to the previous element in the list. If the first element is currently focused, loop to the last element.

deleteLeft :: PointedList a -> Maybe (PointedList a) Source #

Possibly delete the element at the focus, then move the element on the left to the focus. If no element is on the left, focus on the element to the right. If the deletion will cause the list to be empty, return Nothing.

deleteRight :: PointedList a -> Maybe (PointedList a) Source #

Possibly delete the element at the focus, then move the element on the right to the focus. If no element is on the right, focus on the element to the left. If the deletion will cause the list to be empty, return Nothing.