Commits

shl...@52c325ad-5fd0-0310-8a0f-c43feede02cc  committed 94784e4

Now passing ./Build test - full POD coverage.

  • Participants
  • Parent commits 5fa7672

Comments (0)

Files changed (2)

File modules/Math-GrahamFunction/lib/Math/GrahamFunction/SqFacts.pm

 
 Math::GrahamFunction::SqFacts - a squaring factors vector.
 
+=head1 WARNING!
+
+This is a module for Math::GrahamFunction's internal use only.
+
 =cut
 
 use base qw(Math::GrahamFunction::Object);

File modules/Math-GrahamFunction/lib/Math/GrahamFunction/SqFacts/Dipole.pm

 Math::GrahamFunction::SqFacts::Dipole - a dipole of two vectors - a result and
 a composition.
 
+=head1 WARNING!
+
+This is a module for Math::GrahamFunction's internal use only.
+
 =cut
 
 use base qw(Math::GrahamFunction::SqFacts);
     return 0;
 }
 
+=head1 METHODS
+
+=head2 my $copy = $dipole->clone()
+
+Clones the dipole returning a new dipole with the clone of the result and the
+composition.
+
+=cut
+
 sub clone
 {
     my $self = shift;
         });
 }
 
+=head2 $changing_dipole->mult_by($constant_dipole)
+
+Multiplies the result by the result and the composition by the composition.
+
+=cut
+
 sub mult_by
 {
     my $n_ref = shift;
     return 0;
 }
 
+=head2 $bool = $dipole->is_square()
+
+Returns whether the result is square.
+
+=cut
+
 sub is_square
 {
     my $self = shift;
     return $self->result()->is_square();
 }
 
+=head2 $bool = $dipole->exists($factor)
+
+Returns whether the factor exists in the result.
+
+=cut
+
 sub exists
 {
     my ($self, $factor) = @_;
     return $self->result()->exists($factor);
 }
 
+=head2 $first_factor = $dipole->first()
+
+Returns the C<first()> factor of the result vector.
+
+=cut
+
 sub first
 {
     my $self = shift;
     return $self->result()->first();
 }
 
+=head2 $factors = $dipole->factors()
+
+Equivalent to C<$dipole->result()->factors()>.
+
+=cut
+
 sub factors
 {
     my $self = shift;