< Back

Packages

package root

Definition Classes
root
package cats
The cats root package contains all the trait signatures of most Scala type classes.
The cats root package contains all the trait signatures of most Scala type classes.
Cats type classes are implemented using the approach from the Type classes as objects and implicits article.
For each type class, cats provides three pieces: - Its signature: a trait that is polymorphic on a type parameter. Type class traits inherit from other type classes to indicate that any implementation of the lower type class (e.g. Applicative) can also serve as an instance for the higuer type class (e.g. Functor). - Type class 'instances, which are classes and objects that implement one or more type class signatures for some specific types. Type class instances for several data types from the Java or Scala standard libraries are declared in the subpackage cats.instances. - Syntax extensions, each of which provides the methods of the type class defines as extension methods (which in Scala 2 are encoded as implicit classes) for values of any type F; given that an instance of the type class for the receiver type (this) is in the implicit scope. Symtax extensions are declared in the cats.syntax package. - A set of laws, that are also generic on the type of the class, and are only defined on the operations of the type class. The purpose of these laws is to declare some algebraic relations (equations) between Scala expressions involving the operations of the type class, and test (but not verify) that implemented instances satisfy those equations. Laws are defined in the cats-laws package.
Although most of cats type classes are declared in this package, some are declared in other packages: - type classes that operate on base types (kind *), and their implementations for standard library types, are contained in cats.kernel, which is a different SBT project. However, they are re-exported from this package. - type classes of kind F[_, _], such as cats.arrow.Profunctor" or cats.arrow.Arrow, which are relevant for Functional Reactive Programming or optics, are declared in the cats.arrow package. - Also, those type classes that abstract over (pure or impure) functional runtime effects are declared in the cats-effect library. - Some type classes for which no laws can be provided are left out of the main road, in a small and dirty alley. These are the alleycats.

Definition Classes
root
package kernel

Definition Classes
cats
package instances

Definition Classes
kernel
AllInstances
BigDecimalGroup
BigDecimalInstances
BigDecimalOrder
BigIntGroup
BigIntInstances
BigIntOrder
BigIntUnboundedEnum
BitSetInstances
BitSetPartialOrder
BitSetSemilattice
BooleanBounded
BooleanEnumerable
BooleanInstances
BooleanOrder
ByteBounded
ByteEnumerable
ByteGroup
ByteInstances
ByteOrder
CharBounded
CharEnumerable
CharInstances
CharOrder
DeadlineBounded
DeadlineInstances
DeadlineOrder
DoubleGroup
DoubleInstances
DoubleOrder
DurationBounded
DurationGroup
DurationInstances
DurationOrder
EitherEq
EitherHash
EitherInstances
EqInstances
FiniteDurationBounded
FiniteDurationGroup
FiniteDurationInstances
FiniteDurationOrder
FloatGroup
FloatInstances
FloatOrder
Function0Group
Function0Monoid
Function0Semigroup
Function1Group
Function1Monoid
Function1Semigroup
FunctionInstances
HashInstances
IntBounded
IntEnumerable
IntGroup
IntInstances
IntOrder
ListEq
ListHash
ListInstances
ListMonoid
ListOrder
ListPartialOrder
LongBounded
LongEnumerable
LongGroup
LongInstances
LongOrder
MapEq
MapHash
MapInstances
MapMonoid
OptionEq
OptionHash
OptionInstances
OptionMonoid
OptionOrder
OptionPartialOrder
OrderInstances
PartialOrderInstances
QueueEq
QueueHash
QueueInstances
QueueMonoid
QueueOrder
QueuePartialOrder
SeqEq
SeqHash
SeqInstances
SeqMonoid
SeqOrder
SeqPartialOrder
SetHash
SetInstances
SetPartialOrder
SetSemilattice
ShortBounded
ShortEnumerable
ShortGroup
ShortInstances
ShortOrder
SortedMapCommutativeMonoid
SortedMapCommutativeSemigroup
SortedMapEq
SortedMapHash
SortedMapInstances
SortedMapMonoid
SortedMapSemigroup
SortedSetHash
SortedSetInstances
SortedSetOrder
SortedSetSemilattice
StaticMethods
StreamEq
StreamHash
StreamInstances
StreamMonoid
StreamOrder
StreamPartialOrder
StringInstances
StringLowerBounded
StringMonoid
StringOrder
SymbolInstances
SymbolLowerBounded
SymbolOrder
TupleInstances
UUIDBounded
UUIDInstances
UnitAlgebra
UnitBounded
UnitEnumerable
UnitInstances
UnitOrder
VectorEq
VectorHash
VectorInstances
VectorMonoid
VectorOrder
VectorPartialOrder
eq
hash
order
partialOrder

o

cats.kernel.instances

eq

object eq extends EqInstances

Source: eq.scala

Linear Supertypes

EqInstances, EqToEquivConversion, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

eq
EqInstances
EqToEquivConversion
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def catsKernelEquivForEq[A](implicit ev: Eq[A]): Equiv[A]
Implicitly derive a scala.math.Equiv[A] from a Eq[A] instance.
Implicitly derive a scala.math.Equiv[A] from a Eq[A] instance.

Definition Classes
EqToEquivConversion
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native() @IntrinsicCandidate()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] ) @Deprecated
Deprecated

Inherited from EqInstances

Inherited from EqToEquivConversion

Inherited from AnyRef

Inherited from Any

Ungrouped