From f983600851f14624c92d4e99671ea4d2f7193f7b Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 03:57:14 +0100 Subject: [PATCH 01/20] Added symbols file --- docs/src/main/tut/symbols.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/src/main/tut/symbols.md diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md new file mode 100644 index 0000000000..4f0ce59632 --- /dev/null +++ b/docs/src/main/tut/symbols.md @@ -0,0 +1,3 @@ +Apply builder + +`|@|` ap From 7e001c8efa66a7e850d9a57c11da27fee5a15ab2 Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 04:10:04 +0100 Subject: [PATCH 02/20] Update symbols.md --- docs/src/main/tut/symbols.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 4f0ce59632..3f3b194b94 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,3 +1,3 @@ Apply builder -`|@|` ap +`|@|` `cats.syntax.CartesianOps` From 5b032c9e32c06a9d5e7d93698c9dec919602ac2a Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 04:21:01 +0100 Subject: [PATCH 03/20] Update symbols.md --- docs/src/main/tut/symbols.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 3f3b194b94..0bef49043d 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,3 +1,3 @@ -Apply builder - -`|@|` `cats.syntax.CartesianOps` +| Symbol | Name | Description | Use | +| ------ | ----------------- | ------------------------- | ----| +| `|@|` | Cartesian Builder | Builds up an `apN` method | `(a |@| b |@| c) map { case (aa, bb, cc) => ??? }` | From d62d636e89d9835343b34d4ab3254522c9e511cb Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 04:23:31 +0100 Subject: [PATCH 04/20] Update symbols.md --- docs/src/main/tut/symbols.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 0bef49043d..6db629d09b 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,3 +1,3 @@ | Symbol | Name | Description | Use | | ------ | ----------------- | ------------------------- | ----| -| `|@|` | Cartesian Builder | Builds up an `apN` method | `(a |@| b |@| c) map { case (aa, bb, cc) => ??? }` | +| `|@|` | Cartesian Builder | Builds up an `apN` method | `(fa |@| fb |@| fc) map { (a, b, c) => ??? }` | From a9994cb44fb79fd1b9ecc2b116eddef84c3ca260 Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 04:30:34 +0100 Subject: [PATCH 05/20] Update symbols.md --- docs/src/main/tut/symbols.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 6db629d09b..9b5e07693c 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,3 +1,6 @@ | Symbol | Name | Description | Use | | ------ | ----------------- | ------------------------- | ----| | `|@|` | Cartesian Builder | Builds up an `apN` method | `(fa |@| fb |@| fc) map { (a, b, c) => ??? }` | +| `===` | Equals | Equality check on `Eq` | TBD | +| `=!=` | Not Equals | Inequality check on `Eq` | TBD | +| `|+|` | Semigroup plus | TBD | TBD | From 1a25cf3969fd980b3fcc53009aaa86eae476c52f Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 04:39:48 +0100 Subject: [PATCH 06/20] Update symbols.md --- docs/src/main/tut/symbols.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 9b5e07693c..64bf364323 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -4,3 +4,6 @@ | `===` | Equals | Equality check on `Eq` | TBD | | `=!=` | Not Equals | Inequality check on `Eq` | TBD | | `|+|` | Semigroup plus | TBD | TBD | +| `~>` | Natural transformation | TBD | TBD | +| `⊥` | Nothing | TBD | TBD | +| `⊤` | Any | | TBD | From 3eed7bfb298cc9c23a84954f71be291a204b1096 Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Sat, 21 May 2016 04:53:45 +0100 Subject: [PATCH 07/20] Update symbols.md --- docs/src/main/tut/symbols.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 64bf364323..6f3a6d27a9 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -4,6 +4,7 @@ | `===` | Equals | Equality check on `Eq` | TBD | | `=!=` | Not Equals | Inequality check on `Eq` | TBD | | `|+|` | Semigroup plus | TBD | TBD | +| `<+>` | SemigroupK combine | TBD | TBD | | `~>` | Natural transformation | TBD | TBD | | `⊥` | Nothing | TBD | TBD | | `⊤` | Any | | TBD | From 6b24defd7946d752e72557358a49eefca9e2a9c4 Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Tue, 7 Jun 2016 12:09:13 +0100 Subject: [PATCH 08/20] Updating symbols --- docs/src/main/tut/symbols.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 6f3a6d27a9..2598d875df 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,10 +1,19 @@ -| Symbol | Name | Description | Use | -| ------ | ----------------- | ------------------------- | ----| -| `|@|` | Cartesian Builder | Builds up an `apN` method | `(fa |@| fb |@| fc) map { (a, b, c) => ??? }` | -| `===` | Equals | Equality check on `Eq` | TBD | -| `=!=` | Not Equals | Inequality check on `Eq` | TBD | -| `|+|` | Semigroup plus | TBD | TBD | -| `<+>` | SemigroupK combine | TBD | TBD | -| `~>` | Natural transformation | TBD | TBD | -| `⊥` | Nothing | TBD | TBD | -| `⊤` | Any | | TBD | +| Symbol | Name | Typeclass | Import | Source | +| ------ | ---------------------- | ------------ | -------------------------- | ------------------------------------------------- | +| `<*>` | apply | `Apply` | TBA | core/src/main/scala/cats/Apply.scala | +| `|@|` | Cartesian builder | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | +| `*>` | right apply | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | +| `<*` | left apply | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | +| `===` | equals | `Eq` | `cats.syntax.eq._` | kernel/src/main/scala/cats/kernel/Eq.scala | +| `=!=` | not equals | `Eq` | `cats.syntax.eq._` | kernel/src/main/scala/cats/kernel/Eq.scala | +| `>>=` | flatMap | `FlatMap` | `cats.syntax.flatMap._` | core/src/main/scala/cats/FlatMap.scala | +| `|-|` | remove | `Group` | `cats.syntax.group._` | kernel/src/main/scala/cats/kernel/Group.scala | +| `>` | greater than | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| +| `>=` | greater than or equal | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| +| `<` | less than | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| +| `<=` | less than or equal | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| +| `|+|` | plus | `Semigroup` | `cats.syntax.semigroup._` | kernel/src/main/scala/cats/kernel/Semigroup.scala | +| `<+>` | combine | `SemigroupK` | `cats.syntax.semigroupk._` | core/src/main/scala/cats/SemigroupK.scala | +| `~>` | natural transformation | `FunctionK` | `cats._` | core/src/main/scala/cats/arrow/FunctionK.scala | +| `⊥` | bottom | N/A | `cats._` | core/src/main/scala/cats/package.scala | +| `⊤` | top | N/A | `cats._` | core/src/main/scala/cats/package.scala | \ No newline at end of file From a8b29487c3b834f466d794c1cd233ae6bce1e566 Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Fri, 10 Jun 2016 03:42:41 +0100 Subject: [PATCH 09/20] Changing layout --- docs/src/main/tut/symbols.md | 38 ++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 2598d875df..a43135757d 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,19 +1,19 @@ -| Symbol | Name | Typeclass | Import | Source | -| ------ | ---------------------- | ------------ | -------------------------- | ------------------------------------------------- | -| `<*>` | apply | `Apply` | TBA | core/src/main/scala/cats/Apply.scala | -| `|@|` | Cartesian builder | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | -| `*>` | right apply | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | -| `<*` | left apply | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | -| `===` | equals | `Eq` | `cats.syntax.eq._` | kernel/src/main/scala/cats/kernel/Eq.scala | -| `=!=` | not equals | `Eq` | `cats.syntax.eq._` | kernel/src/main/scala/cats/kernel/Eq.scala | -| `>>=` | flatMap | `FlatMap` | `cats.syntax.flatMap._` | core/src/main/scala/cats/FlatMap.scala | -| `|-|` | remove | `Group` | `cats.syntax.group._` | kernel/src/main/scala/cats/kernel/Group.scala | -| `>` | greater than | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| -| `>=` | greater than or equal | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| -| `<` | less than | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| -| `<=` | less than or equal | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| -| `|+|` | plus | `Semigroup` | `cats.syntax.semigroup._` | kernel/src/main/scala/cats/kernel/Semigroup.scala | -| `<+>` | combine | `SemigroupK` | `cats.syntax.semigroupk._` | core/src/main/scala/cats/SemigroupK.scala | -| `~>` | natural transformation | `FunctionK` | `cats._` | core/src/main/scala/cats/arrow/FunctionK.scala | -| `⊥` | bottom | N/A | `cats._` | core/src/main/scala/cats/package.scala | -| `⊤` | top | N/A | `cats._` | core/src/main/scala/cats/package.scala | \ No newline at end of file +| Symbol | Name | Typeclass | Definition | +| ------ | ---------------------- | --------------------------------------------------------------------- |----------- | +| `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | +| `|@|` | Cartesian builder | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `*>` | right apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map[A, B](Cartesian.product[A, B](fa, fb)) { case (a, b) => b }` | +| `<*` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map[A, B](Cartesian.product[A, B](fa, fb)) { case (a, b) => a }` | +| `x === y` | equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].eqv(x, y)` | +| `x =!= y` | not equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].neqv(x, y)` | +| `fa >>= f` | flatMap | [`FlatMap`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap[A, B].flatMap(fa)(f)` | +| `|-|` | remove | [`Group`](kernel/src/main/scala/cats/kernel/Group.scala) | TBD | +| `>` | greater than | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | +| `>=` | greater than or equal | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | +| `<` | less than | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | +| `<=` | less than or equal | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | +| `|+|` | plus | [`Semigroup`](kernel/src/main/scala/cats/kernel/Semigroup.scala) | TBD | +| `<+>` | combine | [`SemigroupK`](core/src/main/scala/cats/SemigroupK.scala) | TBD | +| `~>` | natural transformation | [`FunctionK`](core/src/main/scala/cats/arrow/FunctionK.scala) | TBD | +| `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | TBD | +| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | TBD | \ No newline at end of file From ad1e06df83f9e08c87c12a7f6ee50879bb08238e Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Fri, 10 Jun 2016 03:51:40 +0100 Subject: [PATCH 10/20] Update symbols.md --- docs/src/main/tut/symbols.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index a43135757d..d71b244841 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,9 +1,9 @@ | Symbol | Name | Typeclass | Definition | | ------ | ---------------------- | --------------------------------------------------------------------- |----------- | | `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | -| `|@|` | Cartesian builder | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `*>` | right apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map[A, B](Cartesian.product[A, B](fa, fb)) { case (a, b) => b }` | -| `<*` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map[A, B](Cartesian.product[A, B](fa, fb)) { case (a, b) => a }` | +| `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map(Cartesian.product(fa, fb)) { case (a, b) => b }` | +| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map(Cartesian.product(fa, fb)) { case (a, b) => a }` | | `x === y` | equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].eqv(x, y)` | | `x =!= y` | not equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].neqv(x, y)` | | `fa >>= f` | flatMap | [`FlatMap`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap[A, B].flatMap(fa)(f)` | @@ -16,4 +16,4 @@ | `<+>` | combine | [`SemigroupK`](core/src/main/scala/cats/SemigroupK.scala) | TBD | | `~>` | natural transformation | [`FunctionK`](core/src/main/scala/cats/arrow/FunctionK.scala) | TBD | | `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | TBD | -| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | TBD | \ No newline at end of file +| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | TBD | From 731d99d592b776aab76a49be8f412774e54ee5df Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Fri, 10 Jun 2016 03:52:15 +0100 Subject: [PATCH 11/20] Update symbols.md --- docs/src/main/tut/symbols.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index d71b244841..2951716f00 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,5 +1,5 @@ | Symbol | Name | Typeclass | Definition | -| ------ | ---------------------- | --------------------------------------------------------------------- |----------- | +| ----------- | ---------------------- | --------------------------------------------------------------------- |----------- | | `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | | `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | | `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map(Cartesian.product(fa, fb)) { case (a, b) => b }` | From 83642aa5caf8205d0bad2c04623b95e7af77344f Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Fri, 10 Jun 2016 03:52:45 +0100 Subject: [PATCH 12/20] Update symbols.md --- docs/src/main/tut/symbols.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 2951716f00..528ff259b9 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,5 +1,5 @@ | Symbol | Name | Typeclass | Definition | -| ----------- | ---------------------- | --------------------------------------------------------------------- |----------- | +| ---------------- | ---------------------- | --------------------------------------------------------------------- |----------- | | `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | | `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | | `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map(Cartesian.product(fa, fb)) { case (a, b) => b }` | From 9c56add0d1beeff56a5a582022debf3f951a7b07 Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Fri, 10 Jun 2016 03:54:51 +0100 Subject: [PATCH 13/20] Update symbols.md --- docs/src/main/tut/symbols.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 528ff259b9..a515196fb4 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,9 +1,9 @@ -| Symbol | Name | Typeclass | Definition | -| ---------------- | ---------------------- | --------------------------------------------------------------------- |----------- | +| Symbol | Name | Typeclass | Definition | +| -------------------------- | ---------------- | ------------ |----------- | | `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | | `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map(Cartesian.product(fa, fb)) { case (a, b) => b }` | -| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.map(Cartesian.product(fa, fb)) { case (a, b) => a }` | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | `Fun` | +| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.m` | | `x === y` | equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].eqv(x, y)` | | `x =!= y` | not equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].neqv(x, y)` | | `fa >>= f` | flatMap | [`FlatMap`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap[A, B].flatMap(fa)(f)` | From 173120da91e4a6c7a06e2bfa9350f7786441832a Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Fri, 10 Jun 2016 04:14:48 +0100 Subject: [PATCH 14/20] Update symbols.md --- docs/src/main/tut/symbols.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index a515196fb4..0a90d6b6d9 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -2,8 +2,8 @@ | -------------------------- | ---------------- | ------------ |----------- | | `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | | `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | `Fun` | -| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | `Functor.m` | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD| +| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | TBD | | `x === y` | equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].eqv(x, y)` | | `x =!= y` | not equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].neqv(x, y)` | | `fa >>= f` | flatMap | [`FlatMap`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap[A, B].flatMap(fa)(f)` | From ffcb6dba48a7934cbd8abb56250e176d6b592420 Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Fri, 10 Jun 2016 04:41:32 +0100 Subject: [PATCH 15/20] Adding symbols --- docs/src/main/tut/symbols.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 0a90d6b6d9..e345d6440b 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,13 +1,14 @@ -| Symbol | Name | Typeclass | Definition | -| -------------------------- | ---------------- | ------------ |----------- | -| `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | -| `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD| -| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `x === y` | equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].eqv(x, y)` | -| `x =!= y` | not equals | [`Eq`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq[A].neqv(x, y)` | -| `fa >>= f` | flatMap | [`FlatMap`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap[A, B].flatMap(fa)(f)` | -| `|-|` | remove | [`Group`](kernel/src/main/scala/cats/kernel/Group.scala) | TBD | +| Symbol | Name | Typeclass | Definition | +| ---------- | ---------------------- | --------------------------------------------------------------------- |------------------------- | +| `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | +| `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `x === y` | equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.eqv(x, y)` | +| `x =!= y` | not equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | +| `fa >>= f` | flatMap | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | +| `fa >> fb` | followed by | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | +| `|-|` | remove | [`Group[A]`](kernel/src/main/scala/cats/kernel/Group.scala) | `Group.remove(a, b)` | | `>` | greater than | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | | `>=` | greater than or equal | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | | `<` | less than | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | From 2b780408fe9b8310de9d2a2ff39b667bbbcbbac7 Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Fri, 10 Jun 2016 04:54:11 +0100 Subject: [PATCH 16/20] Adding more symbols --- docs/src/main/tut/symbols.md | 40 ++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index e345d6440b..4d4abd0cbf 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,20 +1,20 @@ -| Symbol | Name | Typeclass | Definition | -| ---------- | ---------------------- | --------------------------------------------------------------------- |------------------------- | -| `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | -| `|@|` | Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa <* fb` | left apply | [`Cartesian`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `x === y` | equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.eqv(x, y)` | -| `x =!= y` | not equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | -| `fa >>= f` | flatMap | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | -| `fa >> fb` | followed by | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | -| `|-|` | remove | [`Group[A]`](kernel/src/main/scala/cats/kernel/Group.scala) | `Group.remove(a, b)` | -| `>` | greater than | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | -| `>=` | greater than or equal | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | -| `<` | less than | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | -| `<=` | less than or equal | [`PartialOrder`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| TBD | -| `|+|` | plus | [`Semigroup`](kernel/src/main/scala/cats/kernel/Semigroup.scala) | TBD | -| `<+>` | combine | [`SemigroupK`](core/src/main/scala/cats/SemigroupK.scala) | TBD | -| `~>` | natural transformation | [`FunctionK`](core/src/main/scala/cats/arrow/FunctionK.scala) | TBD | -| `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | TBD | -| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | TBD | +| Symbol | Name | Typeclass | Definition | +| ---------- | ---------------------- | --------------------------------------------------------------------- |------------------------- | +| `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | +| `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa <* fb` | left apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | +| `x === y` | equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.eqv(x, y)` | +| `x =!= y` | not equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | +| `fa >>= f` | flatMap | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | +| `fa >> fb` | followed by | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | +| `x |-| y` | remove | [`Group[A]`](kernel/src/main/scala/cats/kernel/Group.scala) | `Group.remove(x, y)` | +| `x > y` | greater than | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gt(x, y)` | +| `x >= y` | greater than or equal | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gteq(x, y)`| +| `x < y` | less than | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lt(x, y)` | +| `x <= y` | less than or equal | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lteq(x, y)`| +| `x |+| y` | semigroup combine | [`Semigroup[A]`](kernel/src/main/scala/cats/kernel/Semigroup.scala) | `Semigroup.combine(x, y)`| +| `x <+> y` | semigroupk combine | [`SemigroupK[F[_]]`](core/src/main/scala/cats/SemigroupK.scala) | `SemigroupK.combineK(x, y)`| +| `~>` | natural transformation | [`FunctionK`](core/src/main/scala/cats/arrow/FunctionK.scala) | TBD | +| `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | TBD | +| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | TBD | \ No newline at end of file From 959eadd4b7e9d1648de2784289945b939d486f83 Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Fri, 10 Jun 2016 04:58:52 +0100 Subject: [PATCH 17/20] Adding more symbols --- docs/src/main/tut/symbols.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 4d4abd0cbf..08df69013a 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -15,6 +15,6 @@ | `x <= y` | less than or equal | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lteq(x, y)`| | `x |+| y` | semigroup combine | [`Semigroup[A]`](kernel/src/main/scala/cats/kernel/Semigroup.scala) | `Semigroup.combine(x, y)`| | `x <+> y` | semigroupk combine | [`SemigroupK[F[_]]`](core/src/main/scala/cats/SemigroupK.scala) | `SemigroupK.combineK(x, y)`| -| `~>` | natural transformation | [`FunctionK`](core/src/main/scala/cats/arrow/FunctionK.scala) | TBD | -| `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | TBD | -| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | TBD | \ No newline at end of file +| `F ~> G` | natural transformation | [`FunctionK[F[_], G[_]]`](core/src/main/scala/cats/arrow/FunctionK.scala)| `FunctionK` alias | +| `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | N/A | +| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | N/A | \ No newline at end of file From bb73dfee07a6d4aacf92a0a80193b5d465d794f6 Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Fri, 10 Jun 2016 05:03:41 +0100 Subject: [PATCH 18/20] Adding more symbols --- docs/src/main/tut/symbols.md | 40 ++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 08df69013a..11df0a214d 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,20 +1,20 @@ -| Symbol | Name | Typeclass | Definition | -| ---------- | ---------------------- | --------------------------------------------------------------------- |------------------------- | -| `<*>` | apply | [`Apply`](core/src/main/scala/cats/Apply.scala) | TBD | -| `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa *> fb` | right apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa <* fb` | left apply | [`Cartesian[F[_]]`](core/src/main/scala/cats/Cartesian.scala) | TBD | -| `x === y` | equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.eqv(x, y)` | -| `x =!= y` | not equals | [`Eq[A]`](kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | -| `fa >>= f` | flatMap | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | -| `fa >> fb` | followed by | [`FlatMap[F[_]]`](core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | -| `x |-| y` | remove | [`Group[A]`](kernel/src/main/scala/cats/kernel/Group.scala) | `Group.remove(x, y)` | -| `x > y` | greater than | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gt(x, y)` | -| `x >= y` | greater than or equal | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gteq(x, y)`| -| `x < y` | less than | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lt(x, y)` | -| `x <= y` | less than or equal | [`PartialOrder[A]`](kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lteq(x, y)`| -| `x |+| y` | semigroup combine | [`Semigroup[A]`](kernel/src/main/scala/cats/kernel/Semigroup.scala) | `Semigroup.combine(x, y)`| -| `x <+> y` | semigroupk combine | [`SemigroupK[F[_]]`](core/src/main/scala/cats/SemigroupK.scala) | `SemigroupK.combineK(x, y)`| -| `F ~> G` | natural transformation | [`FunctionK[F[_], G[_]]`](core/src/main/scala/cats/arrow/FunctionK.scala)| `FunctionK` alias | -| `⊥` | bottom | [N/A](core/src/main/scala/cats/package.scala) | N/A | -| `⊤` | top | [N/A](core/src/main/scala/cats/package.scala) | N/A | \ No newline at end of file +| Symbol | Name | Typeclass | Definition | +| ---------- | ---------------------- | --------------------------------------------------------------------------------- |------------------------- | +| `<*>` | apply | [`Apply`](../../../../core/src/main/scala/cats/Apply.scala) | TBD | +| `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | +| `fa <* fb` | left apply | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | +| `x === y` | equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.eqv(x, y)` | +| `x =!= y` | not equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | +| `fa >>= f` | flatMap | [`FlatMap[F[_]]`](../../../../core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | +| `fa >> fb` | followed by | [`FlatMap[F[_]]`](../../../../core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | +| `x |-| y` | remove | [`Group[A]`](../../../../kernel/src/main/scala/cats/kernel/Group.scala) | `Group.remove(x, y)` | +| `x > y` | greater than | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gt(x, y)` | +| `x >= y` | greater than or equal | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gteq(x, y)`| +| `x < y` | less than | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lt(x, y)` | +| `x <= y` | less than or equal | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lteq(x, y)`| +| `x |+| y` | semigroup combine | [`Semigroup[A]`](../../../../kernel/src/main/scala/cats/kernel/Semigroup.scala) | `Semigroup.combine(x, y)`| +| `x <+> y` | semigroupk combine | [`SemigroupK[F[_]]`](../../../../core/src/main/scala/cats/SemigroupK.scala) | `SemigroupK.combineK(x, y)`| +| `F ~> G` | natural transformation | [`FunctionK[F[_], G[_]]`](../../../../core/src/main/scala/cats/arrow/FunctionK.scala)| `FunctionK` alias | +| `⊥` | bottom | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | +| `⊤` | top | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | \ No newline at end of file From 067a5ad2f29d98af26b2a13bea7c11b2489ecefd Mon Sep 17 00:00:00 2001 From: zainab-ali Date: Fri, 10 Jun 2016 05:09:46 +0100 Subject: [PATCH 19/20] Update symbols.md --- docs/src/main/tut/symbols.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 11df0a214d..723f8f96fd 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -4,7 +4,7 @@ | `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | | `fa *> fb` | right apply | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | | `fa <* fb` | left apply | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | -| `x === y` | equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.eqv(x, y)` | +| `x === y` | equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `eqv(x: A, y: A): Boolean` | | `x =!= y` | not equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | | `fa >>= f` | flatMap | [`FlatMap[F[_]]`](../../../../core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | | `fa >> fb` | followed by | [`FlatMap[F[_]]`](../../../../core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | @@ -17,4 +17,4 @@ | `x <+> y` | semigroupk combine | [`SemigroupK[F[_]]`](../../../../core/src/main/scala/cats/SemigroupK.scala) | `SemigroupK.combineK(x, y)`| | `F ~> G` | natural transformation | [`FunctionK[F[_], G[_]]`](../../../../core/src/main/scala/cats/arrow/FunctionK.scala)| `FunctionK` alias | | `⊥` | bottom | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | -| `⊤` | top | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | \ No newline at end of file +| `⊤` | top | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | From 96d75304163ecda17dfcc628806a18f88dd37b7f Mon Sep 17 00:00:00 2001 From: Zainab Ali Date: Fri, 10 Jun 2016 12:06:04 +0100 Subject: [PATCH 20/20] Adding Symbols chart --- docs/src/main/tut/symbols.md | 51 ++++++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/docs/src/main/tut/symbols.md b/docs/src/main/tut/symbols.md index 723f8f96fd..000f800d2a 100644 --- a/docs/src/main/tut/symbols.md +++ b/docs/src/main/tut/symbols.md @@ -1,20 +1,31 @@ -| Symbol | Name | Typeclass | Definition | -| ---------- | ---------------------- | --------------------------------------------------------------------------------- |------------------------- | -| `<*>` | apply | [`Apply`](../../../../core/src/main/scala/cats/Apply.scala) | TBD | -| `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa *> fb` | right apply | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | -| `fa <* fb` | left apply | [`Cartesian[F[_]]`](../../../../core/src/main/scala/cats/Cartesian.scala) | TBD | -| `x === y` | equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `eqv(x: A, y: A): Boolean` | -| `x =!= y` | not equals | [`Eq[A]`](../../../../kernel/src/main/scala/cats/kernel/Eq.scala) | `Eq.neqv(x, y)` | -| `fa >>= f` | flatMap | [`FlatMap[F[_]]`](../../../../core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(f)` | -| `fa >> fb` | followed by | [`FlatMap[F[_]]`](../../../../core/src/main/scala/cats/syntax/flatMap.scala) | `FlatMap.flatMap(fa)(_ => fb)` | -| `x |-| y` | remove | [`Group[A]`](../../../../kernel/src/main/scala/cats/kernel/Group.scala) | `Group.remove(x, y)` | -| `x > y` | greater than | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gt(x, y)` | -| `x >= y` | greater than or equal | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.gteq(x, y)`| -| `x < y` | less than | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lt(x, y)` | -| `x <= y` | less than or equal | [`PartialOrder[A]`](../../../../kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `PartialOrder.lteq(x, y)`| -| `x |+| y` | semigroup combine | [`Semigroup[A]`](../../../../kernel/src/main/scala/cats/kernel/Semigroup.scala) | `Semigroup.combine(x, y)`| -| `x <+> y` | semigroupk combine | [`SemigroupK[F[_]]`](../../../../core/src/main/scala/cats/SemigroupK.scala) | `SemigroupK.combineK(x, y)`| -| `F ~> G` | natural transformation | [`FunctionK[F[_], G[_]]`](../../../../core/src/main/scala/cats/arrow/FunctionK.scala)| `FunctionK` alias | -| `⊥` | bottom | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | -| `⊤` | top | [N/A](../../../../core/src/main/scala/cats/package.scala) | N/A | +#Symbols + +Below is a list of symbols used in cats. + +The `~>`, `⊥` and `⊤` symbols can be imported with `import cats._`. + +All other symbols can be imported with `import cats.implicits._` + +A scaladoc generated list is also available on the [Scaladoc symbols page](http://typelevel.org/cats/api/#index.index-_). + +| Symbol | Name | Typeclass | Definition | +| ---------- | ---------------------- | ---------------------------------------------------------------------------------------- |--------------------------------------- | +| `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/Cartesian.scala) | `|@|(fa: F[A])(fb: F[B]): F[(A, B)]` | +| `fa *> fb` | right apply | [`Cartesian[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/Cartesian.scala) | `*>(fa: F[A])(fb: F[B]): F[A]` | +| `fa <* fb` | left apply | [`Cartesian[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/Cartesian.scala) | `<*(fa: F[A])(fb: F[B]): F[B]` | +| `x === y` | equals | [`Eq[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/Eq.scala) | `eqv(x: A, y: A): Boolean` | +| `x =!= y` | not equals | [`Eq[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/Eq.scala) | `neqv(x: A, y: A): Boolean` | +| `fa >>= f` | flatMap | [`FlatMap[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/FlatMap.scala) | `flatMap(fa: F[A])(f: A => F[B]): F[B]`| +| `fa >> fb` | followed by | [`FlatMap[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/FlatMap.scala) | `followedBy(fa: F[A])(fb: F[B]): F[B]` | +| `x |-| y` | remove | [`Group[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/Group.scala) | `remove(x: A, y: A): A` | +| `x > y` | greater than | [`PartialOrder[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `gt(x: A, y: A): Boolean` | +| `x >= y` | greater than or equal | [`PartialOrder[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `gteq(x: A, y: A): Boolean` | +| `x < y` | less than | [`PartialOrder[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `lt(x: A, y: A): Boolean` | +| `x <= y` | less than or equal | [`PartialOrder[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/PartialOrder.scala)| `lteq(x: A, y: A): Boolean` | +| `x |+| y` | Semigroup combine | [`Semigroup[A]`]({{ site.sources }}/kernel/src/main/scala/cats/kernel/Semigroup.scala) | `combine(x: A, y: A): A` | +| `x <+> y` | SemigroupK combine | [`SemigroupK[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/SemigroupK.scala) | `combineK(x: F[A], y: F[A]): F[A]` | +| `F ~> G` | natural transformation | [`FunctionK[F[_], G[_]]`]({{ site.sources }}/core/src/main/scala/cats/arrow/FunctionK.scala)| `FunctionK` alias | +| `F :<: G` | inject | [`Inject[F[_], G[_]]`]({{ site.sources }}/free/src/main/scala/cats/free/package.scala) | `Inject` alias | +| `F :≺: G` | inject | [`Inject[F[_], G[_]]`]({{ site.sources }}/free/src/main/scala/cats/free/package.scala) | `Inject` alias | +| `⊥` | bottom | [N/A]({{ site.sources }}/core/src/main/scala/cats/package.scala) | `Nothing` | +| `⊤` | top | [N/A]({{ site.sources }}/core/src/main/scala/cats/package.scala) | `Any` | \ No newline at end of file