##========================================================================
## POD DOCUMENTATION, auto-generated by podextract.perl

##========================================================================
## NAME
=pod

=head1 NAME

DiaColloDB::XS::CofUtils - XS/C++ utilities for Cofreqs relation compilation

=cut

##========================================================================
## SYNOPSIS
=pod

=head1 SYNOPSIS

 ##========================================================================
 ## PRELIMINARIES
 
 use DiaColloDB::XS::CofUtils;
 
 $cof_or_undef = $cof->generatePairsXS( $tokfile, $outfile );
 
 $bool = canCompileXS32($cof);
 $bool = canCompileXS64($cof);
 $cof = $cof->loadTextFhXS($fh,%opts);
 

=cut

##========================================================================
## DESCRIPTION
=pod

=head1 DESCRIPTION

The DiaColloDB::XS::CofUtils package provides
optimized XS subroutines
for selected work-instensive compile-time methods
of the L<DiaColloDB::Relation::Cofreqs|DiaColloDB::Relation::Cofreqs>
module.

The XS subroutines provided by this package should be used by default
If available on your system.  Otherwise, compatibile pure-perl fallback methods
will be used instead.

=cut

##----------------------------------------------------------------
## DESCRIPTION: DiaColloDB::XS::CofUtils: Cofreqs wrappers
=pod

=head2 Methods

The following methods are imported into
L<DiaColloDB::Relation::Cofreqs|DiaColloDB::Relation::Cofreqs>
if available:

=over 4

=item generatePairsXS

 $cof_or_undef = $cof->generatePairsXS( $tokfile, $outfile );

XS implementation of
L<DiaColloDB::Relation::Cofreqs::generatePairs()|DiaColloDB::Relation::Cofreqs/generatePairs>.



=item canCompileXS32

 $bool = canCompileXS32($cof);

Convenience utility testing for compatibility with 32-bit XS implementation.

=item canCompileXS64

 $bool = canCompileXS64($cof);

Convenience utility testing for compatibility with 64-bit XS implementation.

=item loadTextFhXS

 $cof = $cof->loadTextFhXS($fh,%opts);

XS implementation of
L<DiaColloDB::Relation::Cofreqs::loadTextFh()|DiaColloDB::Relation::Cofreqs/loadTextFh>.

=back

=cut

##========================================================================
## END POD DOCUMENTATION, auto-generated by podextract.perl

##======================================================================
## Footer
##======================================================================
=pod

=head1 AUTHOR

Bryan Jurish E<lt>moocow@cpan.orgE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2020 by Bryan Jurish

This package is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.

=head1 SEE ALSO

L<DiaColloDB::XS(3pm)|DiaColloDB::XS>,
L<DiaColloDB::Relation::Cofreqs(3pm)|DiaColloDB::Relation::Cofreqs>,
L<DiaColloDB(3pm)|DiaColloDB>,
L<perl(1)|perl>,
...


=cut
