vec

1.4.0
4.1.0 4.0.0 3.5.1 3.5.0 3.4.1 3.4.0 3.3.0 3.2.1 3.2.0 3.1.0 3.0.3 3.0.2 3.0.1 3.0.0 2.0.0 1.4.0 1.3.5 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.0 1.1.0 1.0.0
A vectors library for the Gleam programming language
HexDocs
Current section
Files
Jump to
Readme 25 Versions 1 Dependency Dependants Files Activity
vec src vec@vec4.erl
Raw
src/vec@vec4.erl

-module(vec@vec4).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/vec/vec4.gleam").
-export([splat/1, to_list/1, x/1, y/1, z/1, w/1, replace_x/2, replace_y/2, replace_z/2, replace_w/2, map_x/2, map_y/2, map_z/2, map_w/2, swap_xy/1, swap_xz/1, swap_xw/1, swap_yz/1, swap_yw/1, swap_zw/1, map/2, map2/3, result/1, decoder/1]).
-export_type([vec4/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 vec4(EVV) :: {vec4, EVV, EVV, EVV, EVV}.

-file("src/vec/vec4.gleam", 19).
?DOC(
    " Creates a vector with all elements set to a value.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " splat(12)\n"
    " // -> Vec4(12, 12, 12, 12)\n"
    " ```\n"
).
-spec splat(EVX) -> vec4(EVX).
splat(Value) ->
    {vec4, Value, Value, Value, Value}.

-file("src/vec/vec4.gleam", 32).
?DOC(
    " Converts the set into a list of the contained elements.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> to_list()\n"
    " // -> [12, -34, 420, 69]\n"
    " ```\n"
).
-spec to_list(vec4(EVZ)) -> list(EVZ).
to_list(Vector) ->
    [erlang:element(2, Vector),
        erlang:element(3, Vector),
        erlang:element(4, Vector),
        erlang:element(5, Vector)].

-file("src/vec/vec4.gleam", 45).
?DOC(
    " Returns the x element in a vector.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> x()\n"
    " // -> 12\n"
    " ```\n"
).
-spec x(vec4(EWC)) -> EWC.
x(Vector) ->
    erlang:element(2, Vector).

-file("src/vec/vec4.gleam", 58).
?DOC(
    " Returns the y element in a vector.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> y()\n"
    " // -> -34\n"
    " ```\n"
).
-spec y(vec4(EWE)) -> EWE.
y(Vector) ->
    erlang:element(3, Vector).

-file("src/vec/vec4.gleam", 71).
?DOC(
    " Returns the z element in a vector.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> z()\n"
    " // -> 420\n"
    " ```\n"
).
-spec z(vec4(EWG)) -> EWG.
z(Vector) ->
    erlang:element(4, Vector).

-file("src/vec/vec4.gleam", 84).
?DOC(
    " Returns the w element in a vector.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> w()\n"
    " // -> 69\n"
    " ```\n"
).
-spec w(vec4(EWI)) -> EWI.
w(Vector) ->
    erlang:element(5, Vector).

-file("src/vec/vec4.gleam", 97).
?DOC(
    " Returns a new vector with the x element replace with `value`.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> replace_x(777)\n"
    " // -> Vec4(777, -34, 420, 69)\n"
    " ```\n"
).
-spec replace_x(vec4(EWK), EWK) -> vec4(EWK).
replace_x(Vector, Value) ->
    {vec4,
        Value,
        erlang:element(3, Vector),
        erlang:element(4, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 110).
?DOC(
    " Returns a new vector with the y element replace with `value`.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> replace_y(777)\n"
    " // -> Vec4(12, 777, 420, 69)\n"
    " ```\n"
).
-spec replace_y(vec4(EWN), EWN) -> vec4(EWN).
replace_y(Vector, Value) ->
    {vec4,
        erlang:element(2, Vector),
        Value,
        erlang:element(4, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 123).
?DOC(
    " Returns a new vector with the z element replace with `value`.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> replace_z(777)\n"
    " // -> Vec4(12, -34, 777, 69)\n"
    " ```\n"
).
-spec replace_z(vec4(EWQ), EWQ) -> vec4(EWQ).
replace_z(Vector, Value) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(3, Vector),
        Value,
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 136).
?DOC(
    " Returns a new vector with the w element replace with `value`.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> replace_w(777)\n"
    " // -> Vec4(12, -34, 420, 777)\n"
    " ```\n"
).
-spec replace_w(vec4(EWT), EWT) -> vec4(EWT).
replace_w(Vector, Value) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(3, Vector),
        erlang:element(4, Vector),
        Value}.

-file("src/vec/vec4.gleam", 149).
?DOC(
    " Returns a new vector with the x element having had `with` applied to it.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> map_x(fn(n) { n * 2 })\n"
    " // -> Vec4(24, -34, 420, 69)\n"
    " ```\n"
).
-spec map_x(vec4(EWW), fun((EWW) -> EWW)) -> vec4(EWW).
map_x(Vector, Fun) ->
    {vec4,
        Fun(erlang:element(2, Vector)),
        erlang:element(3, Vector),
        erlang:element(4, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 162).
?DOC(
    " Returns a new vector with the y element having had `with` applied to it.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> map_y(fn(n) { n * 2 })\n"
    " // -> Vec4(12, -68, 420, 69)\n"
    " ```\n"
).
-spec map_y(vec4(EWZ), fun((EWZ) -> EWZ)) -> vec4(EWZ).
map_y(Vector, Fun) ->
    {vec4,
        erlang:element(2, Vector),
        Fun(erlang:element(3, Vector)),
        erlang:element(4, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 175).
?DOC(
    " Returns a new vector with the z element having had `with` applied to it.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> map_z(fn(n) { n * 2 })\n"
    " // -> Vec4(12, -34, 840, 69)\n"
    " ```\n"
).
-spec map_z(vec4(EXC), fun((EXC) -> EXC)) -> vec4(EXC).
map_z(Vector, Fun) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(3, Vector),
        Fun(erlang:element(4, Vector)),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 188).
?DOC(
    " Returns a new vector with the w element having had `with` applied to it.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> map_w(fn(n) { n * 2 })\n"
    " // -> Vec4(12, -34, 420, 138)\n"
    " ```\n"
).
-spec map_w(vec4(EXF), fun((EXF) -> EXF)) -> vec4(EXF).
map_w(Vector, Fun) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(3, Vector),
        erlang:element(4, Vector),
        Fun(erlang:element(5, Vector))}.

-file("src/vec/vec4.gleam", 201).
?DOC(
    " Returns a new vector with the x and y elements swaped.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> swap_xy()\n"
    " // -> Vec4(-34, 12, 420, 69)\n"
    " ```\n"
).
-spec swap_xy(vec4(EXI)) -> vec4(EXI).
swap_xy(Vector) ->
    {vec4,
        erlang:element(3, Vector),
        erlang:element(2, Vector),
        erlang:element(4, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 214).
?DOC(
    " Returns a new vector with the x and z elements swaped.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> swap_xz()\n"
    " // -> Vec4(420, -34, 12, 69)\n"
    " ```\n"
).
-spec swap_xz(vec4(EXL)) -> vec4(EXL).
swap_xz(Vector) ->
    {vec4,
        erlang:element(4, Vector),
        erlang:element(3, Vector),
        erlang:element(2, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 227).
?DOC(
    " Returns a new vector with the x and w elements swaped.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> swap_xw()\n"
    " // -> Vec4(69, -34, 420, 12)\n"
    " ```\n"
).
-spec swap_xw(vec4(EXO)) -> vec4(EXO).
swap_xw(Vector) ->
    {vec4,
        erlang:element(5, Vector),
        erlang:element(3, Vector),
        erlang:element(4, Vector),
        erlang:element(2, Vector)}.

-file("src/vec/vec4.gleam", 240).
?DOC(
    " Returns a new vector with the y and z elements swaped.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> swap_yz()\n"
    " // -> Vec4(12, 420, -34, 69)\n"
    " ```\n"
).
-spec swap_yz(vec4(EXR)) -> vec4(EXR).
swap_yz(Vector) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(4, Vector),
        erlang:element(3, Vector),
        erlang:element(5, Vector)}.

-file("src/vec/vec4.gleam", 253).
?DOC(
    " Returns a new vector with the y and w elements swaped.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> swap_yw()\n"
    " // -> Vec4(12, 69, 420, -34)\n"
    " ```\n"
).
-spec swap_yw(vec4(EXU)) -> vec4(EXU).
swap_yw(Vector) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(5, Vector),
        erlang:element(4, Vector),
        erlang:element(3, Vector)}.

-file("src/vec/vec4.gleam", 266).
?DOC(
    " Returns a new vector with the z and w elements swaped.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> swap_zw()\n"
    " // -> Vec4(12, -34, 69, 420)\n"
    " ```\n"
).
-spec swap_zw(vec4(EXX)) -> vec4(EXX).
swap_zw(Vector) ->
    {vec4,
        erlang:element(2, Vector),
        erlang:element(3, Vector),
        erlang:element(5, Vector),
        erlang:element(4, Vector)}.

-file("src/vec/vec4.gleam", 280).
?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"
    " Vec4(12, -34, 420, 69) |> map(fn(x) { x * 2 })\n"
    " // -> Vec4(24, -68, 840, 138)\n"
    " ```\n"
).
-spec map(vec4(EYA), fun((EYA) -> EYC)) -> vec4(EYC).
map(Vector, Fun) ->
    {vec4,
        Fun(erlang:element(2, Vector)),
        Fun(erlang:element(3, Vector)),
        Fun(erlang:element(4, Vector)),
        Fun(erlang:element(5, Vector))}.

-file("src/vec/vec4.gleam", 293).
?DOC(
    " Combines two vectors into a single vector using the given function.\n"
    "\n"
    " ## Examples\n"
    "\n"
    " ```gleam\n"
    " Vec4(12, -34, 420, 69) |> map2(Vec4(1, 2, 3, 4), fn(x, y) { x * y })\n"
    " // -> Vec4(12, -68, 1260, 276)\n"
    " ```\n"
).
-spec map2(vec4(EYE), vec4(EYG), fun((EYE, EYG) -> EYI)) -> vec4(EYI).
map2(A, B, Fun) ->
    {vec4,
        Fun(erlang:element(2, A), erlang:element(2, B)),
        Fun(erlang:element(3, A), erlang:element(3, B)),
        Fun(erlang:element(4, A), erlang:element(4, B)),
        Fun(erlang:element(5, A), erlang:element(5, B))}.

-file("src/vec/vec4.gleam", 313).
?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"
    " Vec4(Ok(12), Ok(-34), Ok(420), Ok(69)) |> result()\n"
    " // -> Ok(Vec4(12, -34, 420, 69))\n"
    " ```\n"
    "\n"
    " ```gleam\n"
    " Vec4(Ok(12), Error(\"foo\"), Ok(420), Error(\"bar\")) |> result()\n"
    " // -> Error(\"foo\")\n"
    " ```\n"
).
-spec result(vec4({ok, EYK} | {error, EYL})) -> {ok, vec4(EYK)} | {error, EYL}.
result(Vector) ->
    case Vector of
        {vec4, {ok, X}, {ok, Y}, {ok, Z}, {ok, W}} ->
            {ok, {vec4, X, Y, Z, W}};

        {vec4, {error, Error}, _, _, _} ->
            {error, Error};

        {vec4, _, {error, Error@1}, _, _} ->
            {error, Error@1};

        {vec4, _, _, {error, Error@2}, _} ->
            {error, Error@2};

        {vec4, _, _, _, {error, Error@3}} ->
            {error, Error@3}
    end.

-file("src/vec/vec4.gleam", 326).
?DOC(
    " A decoder that decodes 4D vectors where all elements are decoded with a\n"
    " given decoder.\n"
).
-spec decoder(gleam@dynamic@decode:decoder(EYS)) -> gleam@dynamic@decode:decoder(vec4(EYS)).
decoder(Inner) ->
    gleam@dynamic@decode:field(
        <<"x"/utf8>>,
        Inner,
        fun(X) ->
            gleam@dynamic@decode:field(
                <<"y"/utf8>>,
                Inner,
                fun(Y) ->
                    gleam@dynamic@decode:field(
                        <<"z"/utf8>>,
                        Inner,
                        fun(Z) ->
                            gleam@dynamic@decode:field(
                                <<"w"/utf8>>,
                                Inner,
                                fun(W) ->
                                    gleam@dynamic@decode:success(
                                        {vec4, X, Y, Z, W}
                                    )
                                end
                            )
                        end
                    )
                end
            )
        end
    ).
Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT