protocol
Comparable
Inheritance |
Equatable
View Protocol Hierarchy →
|
---|---|
Import |
|
Instance Methods
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
This function is the only requirement of the Comparable
protocol. The
remainder of the relational operator functions are implemented by the
standard library for any type that conforms to Comparable
.
Parameters: lhs: A value to compare. rhs: Another value to compare.
Declaration
func
<
(
lhs
:
Self
,
rhs
:
Self
) -
>
Bool
Returns a Boolean value indicating whether the value of the first argument is less than or equal to that of the second argument.
Parameters: lhs: A value to compare. rhs: Another value to compare.
Declaration
func
<
=(
lhs
:
Self
,
rhs
:
Self
) -
>
Bool
Returns a Boolean value indicating whether two values are equal.
Equality is the inverse of inequality. For any values a
and b
,
a == b
implies that a != b
is false
.
Parameters: lhs: A value to compare. rhs: Another value to compare.
Declaration
func
==(
lhs
:
Self
,
rhs
:
Self
) -
>
Bool
Declared In
Equatable
Returns a Boolean value indicating whether the value of the first argument is greater than that of the second argument.
Parameters: lhs: A value to compare. rhs: Another value to compare.
Declaration
func
>
(
lhs
:
Self
,
rhs
:
Self
) -
>
Bool
Returns a Boolean value indicating whether the value of the first argument is greater than or equal to that of the second argument.
Parameters: lhs: A value to compare. rhs: Another value to compare.
Declaration
func
>
=(
lhs
:
Self
,
rhs
:
Self
) -
>
Bool
1 inherited item hidden. (Show all)
A type that can be compared using the relational operators
<
,<=
,>=
, and>
.The
Comparable
protocol is used for types that have an inherent order, such as numbers and strings. Many types in the standard library already conform to theComparable
protocol. AddComparable
conformance to your own custom types when you want to be able to compare instances using relational operators or use standard library methods that are designed forComparable
types.The most familiar use of relational operators is to compare numbers, as in the following example:
You can use special versions of some sequence and collection operations when working with a
Comparable
type. For example, if your array's elements conform toComparable
, you can call thesort()
method without using arguments to sort the elements of your array in ascending order.Conforming to the Comparable Protocol
Types with Comparable conformance implement the less-than operator (
<
) and the equal-to operator (==
). These two operations impose a strict total order on the values of a type, in which exactly one of the following must be true for any two valuesa
andb
:a == b
a < b
b < a
In addition, the following conditions must hold:
a < a
is alwaysfalse
(Irreflexivity)a < b
implies!(b < a)
(Asymmetry)a < b
andb < c
impliesa < c
(Transitivity)To add
Comparable
conformance to your custom types, define the<
and==
operators as static methods of your types. The==
operator is a requirement of theEquatable
protocol, whichComparable
extends---see that protocol's documentation for more information about equality in Swift. Because default implementations of the remainder of the relational operators are provided by the standard library, you'll be able to use!=
,>
,<=
, and>=
with instances of your type without any further code.As an example, here's an implementation of a
Date
structure that stores the year, month, and day of a date:To add
Comparable
conformance toDate
, first declare conformance toComparable
and implement the<
operator function.This function uses the least specific nonmatching property of the date to determine the result of the comparison. For example, if the two
year
properties are equal but the twomonth
properties are not, the date with the lesser value formonth
is the lesser of the two dates.Next, implement the
==
operator function, the requirement inherited from theEquatable
protocol.Two
Date
instances are equal if each of their corresponding properties is equal.Now that
Date
conforms toComparable
, you can compare instances of the type with any of the relational operators. The following example compares the date of the first moon landing with the release of David Bowie's song "Space Oddity":Note that the
>
operator provided by the standard library is used in this example, not the<
operator implemented above.Note: A conforming type may contain a subset of values which are treated as exceptional---that is, values that are outside the domain of meaningful arguments for the purposes of the
Comparable
protocol. For example, the special "not a number" value for floating-point types (FloatingPoint.nan
) compares as neither less than, greater than, nor equal to any normal floating-point value. Exceptional values need not take part in the strict total order.