angle v0.3.0 Angle

Tired of forever converting back and forwards between degrees and radians? Well worry no more; Angle is here to make your life simple!

Magic sigils

Angle defines the ~a sigil so that you can create an Angle easily.

Examples

Creating an Angle from decimal degrees:

iex> use Angle
...> ~a(13.2)d
#Angle<13.2°>

Creating an Angle from radians:

iex> use Angle
...> ~a(0.25)r
#Angle<0.25>

Creating an Angle from gradians:

iex> use Angle
...> ~a(40)g
#Angle<40>

Create an Angle from degrees, minutes and seconds:

iex> use Angle
...> ~a(90,30,50)dms
#Angle<90° 30 50>

Lazy converstion

Most functions in Angle return a potentially modified version of the angle, so that if the angle needs to be converted to radians or degrees for the underlying function to work, then it’ll only be done once.

Examples

Returning the radian representation of an angle

  iex> use Angle
  ...> ~a(13)d
  ...> |> Angle.to_radians()
  ...> |> inspect()
  "{#Angle<13°>, 0.22689280275926282}"

Link to this section Summary

Functions

Convert the angle to it’s absolute value by discarding complete revolutions and converting negatives

Initialize and Angle with zero values

Link to this section Types

Link to this type maybe_number()
maybe_number() :: nil | number()
Link to this type t()
t() :: %Angle{
  d: maybe_number(),
  dms: term(),
  g: maybe_number(),
  r: maybe_number()
}

Link to this section Functions

Link to this function abs(angle)
abs(Angle.t()) :: Angle.t()

Convert the angle to it’s absolute value by discarding complete revolutions and converting negatives.

Examples

iex> ~a(-270)d
...> |> Angle.abs()
#Angle<90°>

iex> ~a(-4.71238898038469)r
...> |> Angle.abs()
#Angle<1.5707963267948966>

iex> ~a(-270,15,45)dms
...> |> Angle.abs()
#Angle<90° 45 15>

iex> ~a(-300)g
...> |> Angle.abs()
#Angle<100>
Link to this function to_degrees(angle)
Link to this function to_gradians(angle)
Link to this function to_radians(angle)
Link to this function zero()
zero() :: t()

Initialize and Angle with zero values

Examples

  iex> Angle.zero()
  #Angle<0>