-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* backporting #3076 Unrelated changes * backporting #3076 Added Aligh typeclass * backporting #3076 Added Align typeclass * backporting #3076 Added Align instances Co-authored-by: Luka Jacobowitz <[email protected]>
- Loading branch information
1 parent
e5c5561
commit 0980189
Showing
40 changed files
with
556 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,6 +17,7 @@ TAGS | |
.idea/* | ||
.idea_modules | ||
.DS_Store | ||
.vscode | ||
.sbtrc | ||
*.sublime-project | ||
*.sublime-workspace | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
package cats | ||
|
||
import simulacrum.typeclass | ||
|
||
import cats.data.Ior | ||
|
||
/** | ||
* `Align` supports zipping together structures with different shapes, | ||
* holding the results from either or both structures in an `Ior`. | ||
* | ||
* Must obey the laws in cats.laws.AlignLaws | ||
*/ | ||
@typeclass trait Align[F[_]] { | ||
|
||
def functor: Functor[F] | ||
|
||
/** | ||
* Pairs elements of two structures along the union of their shapes, using `Ior` to hold the results. | ||
* | ||
* Example: | ||
* {{{ | ||
* scala> import cats.implicits._ | ||
* scala> import cats.data.Ior | ||
* scala> Align[List].align(List(1, 2), List(10, 11, 12)) | ||
* res0: List[Ior[Int, Int]] = List(Both(1,10), Both(2,11), Right(12)) | ||
* }}} | ||
*/ | ||
def align[A, B](fa: F[A], fb: F[B]): F[Ior[A, B]] | ||
|
||
/** | ||
* Combines elements similarly to `align`, using the provided function to compute the results. | ||
* | ||
* Example: | ||
* {{{ | ||
* scala> import cats.implicits._ | ||
* scala> Align[List].alignWith(List(1, 2), List(10, 11, 12))(_.mergeLeft) | ||
* res0: List[Int] = List(1, 2, 12) | ||
* }}} | ||
*/ | ||
def alignWith[A, B, C](fa: F[A], fb: F[B])(f: Ior[A, B] => C): F[C] = | ||
functor.map(align(fa, fb))(f) | ||
|
||
/** | ||
* Align two structures with the same element, combining results according to their semigroup instances. | ||
* | ||
* Example: | ||
* {{{ | ||
* scala> import cats.implicits._ | ||
* scala> Align[List].alignCombine(List(1, 2), List(10, 11, 12)) | ||
* res0: List[Int] = List(11, 13, 12) | ||
* }}} | ||
*/ | ||
def alignCombine[A: Semigroup](fa1: F[A], fa2: F[A]): F[A] = | ||
alignWith(fa1, fa2)(_.merge) | ||
|
||
/** | ||
* Same as `align`, but forgets from the type that one of the two elements must be present. | ||
* | ||
* Example: | ||
* {{{ | ||
* scala> import cats.implicits._ | ||
* scala> Align[List].padZip(List(1, 2), List(10)) | ||
* res0: List[(Option[Int], Option[Int])] = List((Some(1),Some(10)), (Some(2),None)) | ||
* }}} | ||
*/ | ||
def padZip[A, B](fa: F[A], fb: F[B]): F[(Option[A], Option[B])] = | ||
alignWith(fa, fb)(_.pad) | ||
|
||
/** | ||
* Same as `alignWith`, but forgets from the type that one of the two elements must be present. | ||
* | ||
* Example: | ||
* {{{ | ||
* scala> import cats.implicits._ | ||
* scala> Align[List].padZipWith(List(1, 2), List(10, 11, 12))(_ |+| _) | ||
* res0: List[Option[Int]] = List(Some(11), Some(13), Some(12)) | ||
* }}} | ||
*/ | ||
def padZipWith[A, B, C](fa: F[A], fb: F[B])(f: (Option[A], Option[B]) => C): F[C] = | ||
alignWith(fa, fb) { ior => | ||
val (oa, ob) = ior.pad | ||
f(oa, ob) | ||
} | ||
} | ||
|
||
object Align { | ||
def semigroup[F[_], A](implicit F: Align[F], A: Semigroup[A]): Semigroup[F[A]] = new Semigroup[F[A]] { | ||
def combine(x: F[A], y: F[A]): F[A] = Align[F].alignCombine(x, y) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.