G'day jcklasseter,

"This isn't a very well known module, nor well documented (In my google-ing experience)."

To find documentation for a CPAN module, you need to pick the right search engine. I usually use http://search.cpan.org/ and the remainder of my post focusses on that. Another popular one is https://metacpan.org/: investigate at your leisure.

So, from the http://search.cpan.org/ page, enter Math::Vector::Real, click the [CPAN Search] button and follow the first result link to Math::Vector::Real. That certainly looks "well documented" to me; although, my intention here isn't to provide a review of this specific piece of documentation.

In most cases, that's probably all you need to do; however, there's typically a lot more information that you can access should you require it.

Along the top of the page you'll see:

link-to-author > link-to-distribution > module-name

While the "link-to-author" is of occasional interest, it's the "link-to-distribution" where you'll typically find the most useful, additional information. In this instance, that link is Math-Vector-Real-0.17 — follow it.

Now you can see lots more information either directly on this page or via the links provided. If you're having problems installing a module, see the "CPAN Testers" results for your platform; if you're having problems using a module, take a look at outstanding bug reports; and so on. I suggest you spend some time looking at what's available. Other modules may have more or less information than what you're currently looking at.

Of particular note, under Special Files, is the link to MANIFEST. Here you'll find links to all of the files that make up the distribution. There's often an examples/ directory (2 example files in this case) which can help with writing code for a module you haven't used previously; and the t/ (test) directory can be similarly useful.

I suspect you could find all of this through a general search engine; although, you may have to check thousands of results to do so. Searching CPAN directly is, by far, the much better option.

-- Ken

In reply to Re: Vector manipulation by kcott
in thread Vector manipulation by jcklasseter

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.