Current section

Files

Jump to
vec src vec@vec2.erl
Raw

src/vec@vec2.erl

-module(vec@vec2).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch]).
-define(FILEPATH, "src/vec/vec2.gleam").
-export([splat/1, to_list/1, x/1, y/1, replace_x/2, replace_y/2, map_x/2, map_y/2, swap/1, map/2, map2/3, result/1, vec2_decoder/1]).
-export_type([vec2/1]).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
-type vec2(GUQ) :: {vec2, GUQ, GUQ}.
-file("src/vec/vec2.gleam", 18).
?DOC(
" Creates a vector with all elements set to a value.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" splat(12)\n"
" // -> Vec2(12, 12)\n"
" ```\n"
).
-spec splat(GUS) -> vec2(GUS).
splat(Value) ->
{vec2, Value, Value}.
-file("src/vec/vec2.gleam", 31).
?DOC(
" Converts the set into a list of the contained elements.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> to_list()\n"
" // -> [12, -34]\n"
" ```\n"
).
-spec to_list(vec2(GUU)) -> list(GUU).
to_list(Vector) ->
[erlang:element(2, Vector), erlang:element(3, Vector)].
-file("src/vec/vec2.gleam", 44).
?DOC(
" Returns the x element in a vector.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> x()\n"
" // -> 12\n"
" ```\n"
).
-spec x(vec2(GUX)) -> GUX.
x(Vector) ->
erlang:element(2, Vector).
-file("src/vec/vec2.gleam", 57).
?DOC(
" Returns the y element in a vector.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> y()\n"
" // -> -34\n"
" ```\n"
).
-spec y(vec2(GUZ)) -> GUZ.
y(Vector) ->
erlang:element(3, Vector).
-file("src/vec/vec2.gleam", 70).
?DOC(
" Returns a new vector with the x element replace with `value`.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> replace_x(777)\n"
" // -> Vec2(777, -34)\n"
" ```\n"
).
-spec replace_x(vec2(GVB), GVB) -> vec2(GVB).
replace_x(Vector, Value) ->
_record = Vector,
{vec2, Value, erlang:element(3, _record)}.
-file("src/vec/vec2.gleam", 83).
?DOC(
" Returns a new vector with the y element replace with `value`.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> replace_y(777)\n"
" // -> Vec2(12, 777)\n"
" ```\n"
).
-spec replace_y(vec2(GVE), GVE) -> vec2(GVE).
replace_y(Vector, Value) ->
_record = Vector,
{vec2, erlang:element(2, _record), Value}.
-file("src/vec/vec2.gleam", 96).
?DOC(
" Returns a new vector with the x element having had `with` applied to it.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> map_x(fn(n) { n * 2 })\n"
" // -> Vec2(24, -34)\n"
" ```\n"
).
-spec map_x(vec2(GVH), fun((GVH) -> GVH)) -> vec2(GVH).
map_x(Vector, Fun) ->
_record = Vector,
{vec2, Fun(erlang:element(2, Vector)), erlang:element(3, _record)}.
-file("src/vec/vec2.gleam", 109).
?DOC(
" Returns a new vector with the y element having had `with` applied to it.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> map_y(fn(n) { n * 2 })\n"
" // -> Vec2(12, -68)\n"
" ```\n"
).
-spec map_y(vec2(GVK), fun((GVK) -> GVK)) -> vec2(GVK).
map_y(Vector, Fun) ->
_record = Vector,
{vec2, erlang:element(2, _record), Fun(erlang:element(3, Vector))}.
-file("src/vec/vec2.gleam", 122).
?DOC(
" Returns a new vector with the x and y elements swaped.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> swap()\n"
" // -> Vec2(-34, 12)\n"
" ```\n"
).
-spec swap(vec2(GVN)) -> vec2(GVN).
swap(Vector) ->
{vec2, erlang:element(3, Vector), erlang:element(2, Vector)}.
-file("src/vec/vec2.gleam", 136).
?DOC(
" Returns a new vector containing only the elements of the first vector after\n"
" the function has been applied to each one.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> map(fn(x) { x * 2 })\n"
" // -> Vec2(24, -68)\n"
" ```\n"
).
-spec map(vec2(GVQ), fun((GVQ) -> GVS)) -> vec2(GVS).
map(Vector, Fun) ->
{vec2, Fun(erlang:element(2, Vector)), Fun(erlang:element(3, Vector))}.
-file("src/vec/vec2.gleam", 149).
?DOC(
" Combines two vectors into a single vector using the given function.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(12, -34) |> map2(Vec2(420, 69), fn(x, y) { x + y })\n"
" // -> Vec2(432, 35)\n"
" ```\n"
).
-spec map2(vec2(GVU), vec2(GVW), fun((GVU, GVW) -> GVY)) -> vec2(GVY).
map2(A, B, Fun) ->
{vec2,
Fun(erlang:element(2, A), erlang:element(2, B)),
Fun(erlang:element(3, A), erlang:element(3, B))}.
-file("src/vec/vec2.gleam", 169).
?DOC(
" Combines a vector of results into a single result. If all elements in the\n"
" vector are `Ok` then returns an `Ok` holding the vector of values. If any\n"
" element is `Error` then returns the first error.\n"
"\n"
" ## Examples\n"
"\n"
" ```gleam\n"
" Vec2(Ok(12), Ok(-34)) |> result()\n"
" // -> Ok(Vec2(12, -34))\n"
" ```\n"
"\n"
" ```gleam\n"
" Vec2(Ok(12), Error(\"foo\")) |> result()\n"
" // -> Error(\"foo\")\n"
" ```\n"
).
-spec result(vec2({ok, GWA} | {error, GWB})) -> {ok, vec2(GWA)} | {error, GWB}.
result(Vector) ->
case Vector of
{vec2, {ok, X}, {ok, Y}} ->
{ok, {vec2, X, Y}};
{vec2, {error, Error}, _} ->
{error, Error};
{vec2, _, {error, Error@1}} ->
{error, Error@1}
end.
-file("src/vec/vec2.gleam", 178).
?DOC(" A decoder that decodes 2D vectors where all elements are decoded with a given decoder.\n").
-spec vec2_decoder(gleam@dynamic@decode:decoder(GWI)) -> gleam@dynamic@decode:decoder(vec2(GWI)).
vec2_decoder(Inner) ->
gleam@dynamic@decode:field(
<<"x"/utf8>>,
Inner,
fun(X) ->
gleam@dynamic@decode:field(
<<"y"/utf8>>,
Inner,
fun(Y) -> gleam@dynamic@decode:success({vec2, X, Y}) end
)
end
).