Package com.jnape.palatable.lambda.adt.hlist

Class Tuple5<_1,_2,_3,_4,_5>

java.lang.Object
com.jnape.palatable.lambda.adt.hlist.HList
com.jnape.palatable.lambda.adt.hlist.HList.HCons<_1,Tuple4<_2,_3,_4,_5>>
com.jnape.palatable.lambda.adt.hlist.Tuple5<_1,_2,_3,_4,_5>
Type Parameters:
_1 - The first slot element type
_2 - The second slot element type
_3 - The third slot element type
_4 - The fourth slot element type
_5 - The fifth slot element type
All Implemented Interfaces:
Product2<_1,_2>, Product3<_1,_2,_3>, Product4<_1,_2,_3,_4>, Product5<_1,_2,_3,_4,_5>, Applicative<_5,Tuple5<_1,_2,_3,_4,?>>, Bifunctor<_4,_5,Tuple5<_1,_2,_3,?,?>>, BoundedBifunctor<_4,_5,Object,Object,Tuple5<_1,_2,_3,?,?>>, Functor<_5,Tuple5<_1,_2,_3,_4,?>>, Monad<_5,Tuple5<_1,_2,_3,_4,?>>, MonadRec<_5,Tuple5<_1,_2,_3,_4,?>>, Traversable<_5,Tuple5<_1,_2,_3,_4,?>>, Map.Entry<_1,_2>
public class Tuple5<_1,_2,_3,_4,_5> extends HList.HCons<_1,Tuple4<_2,_3,_4,_5>> implements Product5<_1,_2,_3,_4,_5>, MonadRec<_5,Tuple5<_1,_2,_3,_4,?>>, Bifunctor<_4,_5,Tuple5<_1,_2,_3,?,?>>, Traversable<_5,Tuple5<_1,_2,_3,_4,?>>
A 5-element tuple product type, implemented as a specialized HList. Supports random access.
See Also:

  • Field Details

    • _1

      private final _1 _1

    • _2

      private final _2 _2

    • _3

      private final _3 _3

    • _4

      private final _4 _4

    • _5

      private final _5 _5

  • Constructor Details

  • Method Details

    • cons

      public <_0> Tuple6<_0,_1,_2,_3,_4,_5> cons(_0 _0)
      Cons an element onto the front of this HList.
      Overrides:
      cons in class HList.HCons<_1,Tuple4<_2,_3,_4,_5>>
      Type Parameters:
      _0 - the new head type
      Parameters:
      _0 - the new head element
      Returns:
      the updated HList

    • snoc

      public <_6> Tuple6<_1,_2,_3,_4,_5,_6> snoc(_6 _6)
      Snoc an element onto the back of this Tuple5.
      Type Parameters:
      _6 - the new last element type
      Parameters:
      _6 - the new last element
      Returns:
      the new Tuple6

    • _1

      public _1 _1()
      Retrieve the first element.
      Specified by:
      _1 in interface Product2<_1,_2>
      Returns:
      the first element

    • _2

      public _2 _2()
      Retrieve the second element.
      Specified by:
      _2 in interface Product2<_1,_2>
      Returns:
      the second element

    • _3

      public _3 _3()
      Retrieve the third element.
      Specified by:
      _3 in interface Product3<_1,_2,_3>
      Returns:
      the third element

    • _4

      public _4 _4()
      Retrieve the fourth element.
      Specified by:
      _4 in interface Product4<_1,_2,_3,_4>
      Returns:
      the fourth element

    • _5

      public _5 _5()
      Retrieve the fifth element.
      Specified by:
      _5 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the fifth element

    • rotateL5

      public Tuple5<_2,_3,_4,_5,_1> rotateL5()
      Rotate the first five values of this product one slot to the left.
      Specified by:
      rotateL5 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the left-rotated product

    • rotateR5

      public Tuple5<_5,_1,_2,_3,_4> rotateR5()
      Rotate the first five values of this product one slot to the right.
      Specified by:
      rotateR5 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the right-rotated product

    • rotateL4

      public Tuple5<_2,_3,_4,_1,_5> rotateL4()
      Rotate the first four values of this product one slot to the left.
      Specified by:
      rotateL4 in interface Product4<_1,_2,_3,_4>
      Specified by:
      rotateL4 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the left-rotated product

    • rotateR4

      public Tuple5<_4,_1,_2,_3,_5> rotateR4()
      Rotate the first four values of this product one slot to the right.
      Specified by:
      rotateR4 in interface Product4<_1,_2,_3,_4>
      Specified by:
      rotateR4 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the right-rotated product

    • rotateL3

      public Tuple5<_2,_3,_1,_4,_5> rotateL3()
      Rotate the first three values of this product one slot to the left.
      Specified by:
      rotateL3 in interface Product3<_1,_2,_3>
      Specified by:
      rotateL3 in interface Product4<_1,_2,_3,_4>
      Specified by:
      rotateL3 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the left-rotated product

    • rotateR3

      public Tuple5<_3,_1,_2,_4,_5> rotateR3()
      Rotate the first three values of this product one slot to the right.
      Specified by:
      rotateR3 in interface Product3<_1,_2,_3>
      Specified by:
      rotateR3 in interface Product4<_1,_2,_3,_4>
      Specified by:
      rotateR3 in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the right-rotated product

    • invert

      public Tuple5<_2,_1,_3,_4,_5> invert()
      Rotate the first two slots of this product.
      Specified by:
      invert in interface Product2<_1,_2>
      Specified by:
      invert in interface Product3<_1,_2,_3>
      Specified by:
      invert in interface Product4<_1,_2,_3,_4>
      Specified by:
      invert in interface Product5<_1,_2,_3,_4,_5>
      Returns:
      the rotated product

    • fmap

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> fmap(Fn1<? super _5,? extends _5Prime> fn)
      Covariantly transmute this functor's parameter using the given mapping function. Generally this method is specialized to return an instance of the class implementing Functor.
      Specified by:
      fmap in interface Applicative<_1,_2>
      Specified by:
      fmap in interface Functor<_1,_2>
      Specified by:
      fmap in interface Monad<_1,_2>
      Specified by:
      fmap in interface MonadRec<_1,_2>
      Specified by:
      fmap in interface Traversable<_1,_2>
      Type Parameters:
      _5Prime - the new parameter type
      Parameters:
      fn - the mapping function
      Returns:
      a functor over B (the new parameter type)

    • biMapL

      public <_4Prime> Tuple5<_1,_2,_3,_4Prime,_5> biMapL(Fn1<? super _4,? extends _4Prime> fn)
      Covariantly map over the left parameter.
      Specified by:
      biMapL in interface Bifunctor<_1,_2,_3>
      Specified by:
      biMapL in interface BoundedBifunctor<_1,_2,_3,_4,_5>
      Type Parameters:
      _4Prime - the new left parameter type
      Parameters:
      fn - the mapping function
      Returns:
      a bifunctor over C (the new left parameter) and B (the same right parameter)

    • biMapR

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> biMapR(Fn1<? super _5,? extends _5Prime> fn)
      Covariantly map over the right parameter. For all bifunctors that are also functors, it should hold that biMapR(f) == fmap(f).
      Specified by:
      biMapR in interface Bifunctor<_1,_2,_3>
      Specified by:
      biMapR in interface BoundedBifunctor<_1,_2,_3,_4,_5>
      Type Parameters:
      _5Prime - the new right parameter type
      Parameters:
      fn - the mapping function
      Returns:
      a bifunctor over A (the same left parameter) and C (the new right parameter)

    • biMap

      public <_4Prime, _5Prime> Tuple5<_1,_2,_3,_4Prime,_5Prime> biMap(Fn1<? super _4,? extends _4Prime> lFn, Fn1<? super _5,? extends _5Prime> rFn)
      Dually map covariantly over both the left and right parameters. This is isomorphic to biMapL(lFn).biMapR(rFn).
      Specified by:
      biMap in interface Bifunctor<_1,_2,_3>
      Specified by:
      biMap in interface BoundedBifunctor<_1,_2,_3,_4,_5>
      Type Parameters:
      _4Prime - the new left parameter type
      _5Prime - the new right parameter type
      Parameters:
      lFn - the left parameter mapping function
      rFn - the right parameter mapping function
      Returns:
      a bifunctor over C (the new left parameter type) and D (the new right parameter type)

    • pure

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> pure(_5Prime _5Prime)
      Lift the value b into this applicative functor.
      Specified by:
      pure in interface Applicative<_1,_2>
      Specified by:
      pure in interface Monad<_1,_2>
      Specified by:
      pure in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the type of the returned applicative's parameter
      Parameters:
      _5Prime - the value
      Returns:
      an instance of this applicative over b

    • zip

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> zip(Applicative<Fn1<? super _5,? extends _5Prime>,Tuple5<_1,_2,_3,_4,?>> appFn)
      Given another instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports.
      Specified by:
      zip in interface Applicative<_1,_2>
      Specified by:
      zip in interface Monad<_1,_2>
      Specified by:
      zip in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the resulting applicative parameter type
      Parameters:
      appFn - the other applicative instance
      Returns:
      the mapped applicative

    • lazyZip

      public <_5Prime> Lazy<Tuple5<_1,_2,_3,_4,_5Prime>> lazyZip(Lazy<? extends Applicative<Fn1<? super _5,? extends _5Prime>,Tuple5<_1,_2,_3,_4,?>>> lazyAppFn)
      Given a lazy instance of this applicative over a mapping function, "zip" the two instances together using whatever application semantics the current applicative supports. This is useful for applicatives that support lazy evaluation and early termination.
      Specified by:
      lazyZip in interface Applicative<_1,_2>
      Specified by:
      lazyZip in interface Monad<_1,_2>
      Specified by:
      lazyZip in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the resulting applicative parameter type
      Parameters:
      lazyAppFn - the lazy other applicative instance
      Returns:
      the mapped applicative
      See Also:

    • discardL

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> discardL(Applicative<_5Prime,Tuple5<_1,_2,_3,_4,?>> appB)
      Sequence both this Applicative and appB, discarding this Applicative's result and returning appB. This is generally useful for sequentially performing side-effects.
      Specified by:
      discardL in interface Applicative<_1,_2>
      Specified by:
      discardL in interface Monad<_1,_2>
      Specified by:
      discardL in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the type of the returned Applicative's parameter
      Parameters:
      appB - the other Applicative
      Returns:
      appB

    • discardR

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5> discardR(Applicative<_5Prime,Tuple5<_1,_2,_3,_4,?>> appB)
      Sequence both this Applicative and appB, discarding appB's result and returning this Applicative. This is generally useful for sequentially performing side-effects.
      Specified by:
      discardR in interface Applicative<_1,_2>
      Specified by:
      discardR in interface Monad<_1,_2>
      Specified by:
      discardR in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the type of appB's parameter
      Parameters:
      appB - the other Applicative
      Returns:
      this Applicative

    • flatMap

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> flatMap(Fn1<? super _5,? extends Monad<_5Prime,Tuple5<_1,_2,_3,_4,?>>> f)
      Chain dependent computations that may continue or short-circuit based on previous results.
      Specified by:
      flatMap in interface Monad<_1,_2>
      Specified by:
      flatMap in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the resulting monad parameter type
      Parameters:
      f - the dependent computation over A
      Returns:
      the new monad instance

    • trampolineM

      public <_5Prime> Tuple5<_1,_2,_3,_4,_5Prime> trampolineM(Fn1<? super _5,? extends MonadRec<RecursiveResult<_5,_5Prime>,Tuple5<_1,_2,_3,_4,?>>> fn)
      Given some operation yielding a RecursiveResult inside this MonadRec, internally trampoline the operation until it yields a termination instruction.

      Stack-safety depends on implementations guaranteeing that the growth of the call stack is a constant factor independent of the number of invocations of the operation. For various examples of how this can be achieved in stereotypical circumstances, see the referenced types.

      Specified by:
      trampolineM in interface MonadRec<_1,_2>
      Type Parameters:
      _5Prime - the ultimate resulting carrier type
      Parameters:
      fn - the function to internally trampoline
      Returns:
      the trampolined MonadRec
      See Also:

    • traverse

      public <_5Prime, App extends Applicative<?, App>, TravB extends Traversable<_5Prime, Tuple5<_1, _2, _3, _4, ?>>, AppTrav extends Applicative<TravB, App>> AppTrav traverse(Fn1<? super _5,? extends Applicative<_5Prime,App>> fn, Fn1<? super TravB,? extends AppTrav> pure)
      Apply fn to each element of this traversable from left to right, and collapse the results into a single resulting applicative, potentially with the assistance of the applicative's pure function.
      Specified by:
      traverse in interface Traversable<_1,_2>
      Type Parameters:
      _5Prime - the resulting element type
      App - the result applicative type
      TravB - this Traversable instance over B
      AppTrav - the full inferred resulting type from the traversal
      Parameters:
      fn - the function to apply
      pure - the applicative pure function
      Returns:
      the traversed Traversable, wrapped inside an applicative

    • init

      public Tuple4<_1,_2,_3,_4> init()
      Returns a Tuple4<_1, _2, _3, _4> of all the elements of this Tuple5<_1, _2, _3, _4, _5> except the last.
      Returns:
      The Tuple4<_1, _2, _3, _4> representing all but the last element

    • fill

      public static <A> Tuple5<A,A,A,A,A> fill(A a)
      Given a value of type A, produced an instance of this tuple with each slot set to that value.
      Type Parameters:
      A - the value type
      Parameters:
      a - the value to fill the tuple with
      Returns:
      the filled tuple
      See Also:

    • fromIterable

      public static <A> Maybe<Tuple5<A,A,A,A,A>> fromIterable(Iterable<A> as)
      Return just the first five elements from the given Iterable, or nothing if there are less than five elements.
      Type Parameters:
      A - the Iterable element type
      Parameters:
      as - the Iterable
      Returns:
      Maybe the first five elements of the given Iterable

    • pureTuple

      public static <_1, _2, _3, _4> Pure<Tuple5<_1,_2,_3,_4,?>> pureTuple(_1 _1, _2 _2, _3 _3, _4 _4)
      The canonical Pure instance for Tuple5.
      Type Parameters:
      _1 - the head element type
      _2 - the second element type
      _3 - the third element type
      _4 - the fourth element type
      Parameters:
      _1 - the head element
      _2 - the second element
      _3 - the third element
      _4 - the fourth element
      Returns:
      the Pure instance