- Reference >
- Operators >
- Aggregation Pipeline Operators >
- $tan (aggregation)
$tan (aggregation)¶
-
$tan
¶ New in version 4.2.
Returns the tangent of a value that is measured in radians.
$tan
has the following syntax:$tan
takes any valid expression that resolves to a number. If the expression returns a value in degrees, use the$degreesToRadians
operator to convert the result to radians.By default
$tan
returns values as adouble
.$tan
can also return values as a 128-bit decimal as long as the<expression>
resolves to a 128-bit decimal value.For more information on expressions, see Expressions.
Behavior¶
null
, NaN
, and +/- Infinity
¶
If the argument resolves to a value of null
or refers to a field
that is missing, $tan
returns null
. If the
argument resolves to NaN
, $tan
returns NaN
.
If the argument resolves to negative or positive infinity,
$tan
throws an error.
Example | Results |
---|---|
{ $tan: NaN } |
NaN |
{ $tan: null } |
null |
or
|
Throws an error message resembling the following formatted output: |
Example¶
- Tangent of Value in Degrees
- Tangent of Value in Radians
The trigonometry
collection contains a document that
stores one side and one angle in a right-angle triangle:
The following aggregation operation uses the
$tans
expression to calculate the side opposite
to angle_a
and add it to the input document using the
$addFields
pipeline stage.
The $degreesToRadians
expression converts the
degree value of angle_a
to the equivalent value in radians.
The command returns the following output:
Since angle_a
and side_a
are stored as
128-bit decimals, the output of
$tan
is a 128-bit decimal.
The trigonometry
collection contains a document that
stores the hypotenuse and one angle in a right-angle triangle:
The following aggregation operation uses the
$tan
expression to calculate the side adjacent
to angle_a
and add it to the input document using the
$addFields
pipeline stage.
The command returns the following output:
Since angle_a
and side_a
are stored as
128-bit decimals, the output of
$tan
is a 128-bit decimal.