NAME

DataStructure::LinkedList - simple implementation for using LinkedList data structure.

VERSION

Version 0.02

SYNOPSIS

Quick summary of what the module does.

Perhaps a little code snippet.

    use DataStructure::LinkedList;

    my $list = new DataStructure::LinkedList;
    $list->insert(20);
    $list->insert(15);
    $list->insert(18);
    $list->insert(37);
    $list->insert(3);

    # display
    my $iter = $list->iterator;
    while ($iter->has_next) {
       print $iter->next->data . "\n";
    }
    # you can see result sorted
    # 3
    # 15
    # 18
    # 20
    # 37
    ...
    
    # you can also use strings as cells
    $list = new DataStructure::LinkedList;
    $list->insert('steeve');
    $list->insert('hisashi');
    $list->insert('takairo');
    $list->insert('kazuyo');
    $list->insert('jane');
    
    # display
    $iter = $list->iterator;
    while ($iter->has_next) {
       print $iter->next->data . "\n";
    }
    # you can see result sorted
    # hisashi
    # jane
    # kazuyo
    # takahiro
    # steeve
    ...

    # you can also use some object as cells
    $list = new DataStructure::LinkedList;
    $list->insert(new Person(name => 'lally'));
    $list->insert(new Person(name => 'hisashi'));
    $list->insert(new Person(name => 'takairo'));
    $list->insert(new Person(name => 'kazuyo'));
    $list->insert(new Person(name => 'jane'));
    
    # you have to implements compare_to method in you object.
    # you have to write sort logic in compare_to method.
    package Person;
    use parent qw/Class::Accessor/;
    __PACKAGE__->mk_accessors(qw/length/);
    ...
    sub new {
        my ($class, %self) = @_;
        $self{'length'} = length($self{'name'});
        bless \%self => $class;
        return \%self;
    }
    ...
    # sort by name's length
    sub compare_to {
        my $self = shift;
        my $cell = shift;
        return $self->length > $cell->length ? 1 : 0;
    }

DESCRIPTION

This module is simple implementation for using LinkedList data structure. The cells inserted this LinkedList is sorted by value automatically. If you want to sort by original logic, you have to make orignal class and implement compare_to method. You can see SYNOPOSIS as a example;

SUBROUTINES/METHODS

new

constructor. Any arguments don't require.

insert($cell)

insert a cell on the linked list. You can see SYNOPSIS as a example.

iterator

get a iterator to traverse the linked list. You can see SYNOPSIS as a example.

AUTHOR

Shinchi Takahiro, <shinchi.xx at gmail.com>

BUGS

Please report any bugs or feature requests to bug-datastructure-linkedlist at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DataStructure-LinkedList. 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 DataStructure::LinkedList

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Shinchi Takahiro.

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.