Skip to main content

Sequence Generation Tools inspired by Python itertools.

Project description

seqgentools

Sequence Generation Tools

Motivation

Python itertools package provides users with capability of creating “iterators for efficient loopings”. From the prospectives of machine-learning techniques, “itertools” could be a good tool to define a large multi-dimensional array succinctly without actually allocating memory for the array.

For example, following code snippet generates a 3-dimensional space that has 1,000 data points:

>>> for x,y,z in itertools.product(range(10), repeat=3):
>>>     # DO work on each "point of (x,y,z)"

However, itertools has one critical drawback to be used as a search space generator for Machine-learning techniques: Its element should be accessed sequentially. For example, to access to the last point of (9,9,9) in previous code example, you need to go through all 999 elements from (0,0,0) to (9,9,8). It is because Python iterator does not support indexing. Next code example shows that iterator can not be indexed.

>>> space = itertools.product(range(10), repeat=3)
>>> space[999]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'itertools.product' object is not subscriptable

“seqgentools” takes the core capabilities of “itertools” and adds indexing capability to them.

>>> import seqgentools as seq
>>> space = seq.Product(range(10), repeat=3)
>>> space[999]
(9, 9, 9)

Installation

“seqgentools” can be easily installed using “pip” as shown below.

>>> pip install seqgentools --user

To access the latest features, please download from this repository using git.

>>> git clone https://github.com/NCAR/seqgentools.git

Getting-started

Whenever possible, “seqgentools” follows conventions of using “itertools” so that user can leverage of their knowledge about “itertools”. If you are not familiar with “itertools”, I believe, it is worth of investing a couple of miniutes to see what it can do for you.

Doing is believing: please follow examples shown below to get an idea of how “seqgentools” works.

>>> import seqgentools as seq
>>>
>>> ###### Count #######
>>>
>>> seq.Count(10)[10]
20
>>>
>>> ###### Cycle #######
>>>
>>> seq.Cycle((1,2,3))[10]
2
>>>
>>> ###### Repeat #######
>>>
>>> seq.Repeat(1)[10]
1
>>>
>>> ###### Chain #######
>>>
>>> list(seq.Chain(range(3), range(4)))
[0, 1, 2, 0, 1, 2, 3]
>>>
>>> ###### Product #######
>>>
>>> prod = seq.Product(range(2), range(2))
>>> list(prod)
[(0, 0), (0, 1), (1, 0), (1, 1)]
>>> prod[3]
(1, 1)
>>>
>>> ###### Permutations #######
>>>
>>> perm = seq.Permutations("ABC", 2)
>>> list(perm)
[('A', 'B'), ('A', 'C'), ('B', 'A'), ('B', 'C'), ('C', 'A'),
    ('C', 'B')]
>>> perm[3]
('B', 'C')
>>>
>>> ###### Combinations #######
>>>
>>> comb = seq.Combinations("ABC", 2)
>>> list(comb)
[('A', 'B'), ('A', 'C'), ('B', 'C')]
>>> comb[2]
('B', 'C')
>>>
>>> ###### PermutationRange #######
>>>
>>> permrange = seq.PermutationRange("ABC")
>>> list(permrange)
[(), ('A',), ('B',), ('C',), ('A', 'B'), ('A', 'C'), ('B', 'A'),
    ('B', 'C'), ('C', 'A'), ('C', 'B'), ('A', 'B', 'C'), ('A', 'C', 'B'),
    ('B', 'A', 'C'), ('B', 'C', 'A'), ('C', 'A', 'B'), ('C', 'B', 'A')]
>>> permrange[3]
('C',)
>>>
>>> ###### CombinationRange #######
>>>
>>> combrange = seq.CombinationRange("ABC")
>>> list(combrange)
[(), ('A',), ('B',), ('C',), ('A', 'B'), ('A', 'C'), ('B', 'C'),
    ('A', 'B', 'C')]
>>> combrange[2]
('B',)

As of this version, “seqgentools” implemented follwoing sequence generators.

  • Count: generates a sequence of, possibily infinite, evenly spaced numbers
  • Cycle: generates a cyclic chain of another sequence
  • Repeat: generates a repeating sequece of object
  • Chain: generates a chained sequence of another sequences
  • Product: generates a sequence of mathematical product of another sequences
  • Permutations: generates a permuted sequence of another sequence
  • Combinations: generates a combinated sequence of another sequence
  • PermutationRange: generates a chained sequence of series of permuted sequence
    ranging r=0 to r=n of another sequence
  • CombinationRange: generates a chained sequence of series of combinated sequence
    ranging r=0 to r=n of another sequence
  • Wrapper: generates a sequence from Python sequece data types

[NOTES]

  • “seqgentools” supports indexing of infinite sequences.
  • “Product”, “Permutations”, “Combinations”, “PermutationRange”, and “CombinationRange” do not accept infinite sequence as their input(s).
  • test codes in “tests” subdirectory could be a good place to start further investigation.
  • “Wrapper” sequence generator wraps Python sequence data types such as list, tuple, dictionary, string, set, etc.
  • The name of sequence generators in “seqgentools” starts with a capital letter while “itertools” starts with a lower-case. This is to emphasize that sequence generators are instantiated from class, not from function.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for seqgentools, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size seqgentools-0.0.11-py2.py3-none-any.whl (11.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size seqgentools-0.0.11.tar.gz (7.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page