The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Math-VectorXYZ-1.01
River stage zero No dependents
/ Math::VectorXYZ

NAME

Math::VectorXYZ - Basic 3d vector operations

SYNOPSIS

The following vector operations are provided:

Create a vector

    use Math::VectorXYZ;

    my $v1 = Vec(1,2,3);
    my $v2 = Math::VectorXYZ->new(4,5,6);

Add, subtract, multiply, and divide

    my $v_add = $v1 + $v2;
    my $v_sub = $v1 - $v2;

    my $v_mul = 7 * $v1 or $v1 * 7;
    my $v_div = $v1 / 7;

Dot product, cross product, printing, etc

    my $v_dot = $v1.$v2;
    my $v_cross = $v1 x $v2;
    my $unit_vec = $v1->uvec;

    my $magnitude = $v1->mag;
    my $projection = $v1->proj( $v2 );
    my $angle = $v1->angle( $v2 );

    print $v1;

EXPORT

The Vec() function is exported by default for easy vector creation.

DESCRIPTION

This module is designed for 3d vector math common to engineering problems such as manipulating finite element data (forces and geometry), calculating moments or perpendicular vectors using cross products, etc.

The API is intended to be minimal and intuitive using common perl operators where possible.

Note: See Math::VectorXYZ::2D if working with 2D vectors

Vector Creation

New vectors are created using either the Vec() function or the object oriented interface as:

    my $v1 = Vec(1,2,3);

    my $v2 = Math::VectorXYZ->new(4,5,6);

Vector Internals

The resulting vector object is an array reference $v1 = [x,y,z] blessed into the VectorXYZ class. Individual components of the vector object may be accessed or changed directly as:

    $x = $v1->[0];
    $y = $v1->[1];
    $z = $v1->[2];

Vector Operations

Overload methods

Most of the vector math functionality is available via common perl (overloaded) operators:

    '+' => 'vec_add',
    '-' => 'vec_subtract',
    '*' => 'vec_scalar_mult',
    '/' => 'vec_scalar_div',
    'x' => 'vec_cross',
    '.' => 'vec_dot',

Note: The perl overloading logic also provides related operators +=, -=, *=, /= from these.

Object methods

Additional methods available to be called on the object are:

Vector result

    $v1->uvec             Returns a new unit vector from $v1

Scalar result

    $v1->mag              Returns vector magnitude
    $v1->proj( $v2 )      Returns the projection of $v1 onto $v2
    $v1->angle( $v2 )     Returns the angle (deg) between vectors

    print $v1             Returns string output of vector as "<x,y,z>"

CAVEATS

The code provides minimal input validation:

  • Number of arguments == 3 for vector constructors

  • Arguments to 'proj' and 'angle' methods are vector objects

Note: Invalid inputs will cause the program to either die, or throw errors or warnings according to default perl behavior for division by zero, non-numeric data types, etc.

AUTHOR

Ryan Matthew, <rmatthew at cpan.org>

BUGS

Please report any bugs or feature requests to bug-math-vectorxyz at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Math-VectorXYZ. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Math::VectorXYZ

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2017 Ryan Matthew.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.