ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/bioseg/trunk/README.bioseg
(Generate patch)
# Line 62 | Line 62
62   SYNTAX
63   ======
64  
65 < The external representation of an interval is formed using one or two
65 > The user visible representation of an interval is formed using one or two
66   integers greater than 0 joined by the range operator ('..' or '...').
67   The first integer must be less than or equal to the second.
68  
69 < 11..22        An interval from 10 to 20 inclusive - length 11 (= 22-11+1)
69 >  11..22        An interval from 10 to 20 inclusive - length 11 (= 22-11+1)
70  
71 < 1...2         The same as 1..2
71 >  1...2         The same as 1..2
72  
73 < 50            The same as 50..50
73 >  50            The same as 50..50
74 >
75 > In a statement, bioseg values have the form:
76 >  '<start>..<end>'::bioseg
77 > or can be created with:
78 >  bioseg_create(start, end)
79 >
80 > For example:
81 >  CREATE TABLE test_bioseg (id integer, seg bioseg);
82 >  insert into test_bioseg values (1, '1000..2000'::bioseg);
83 > or, equivalently
84 >  insert into test_bioseg values (1, bioseg_create(1000, 2000));
85  
86  
87   USAGE
88   =====
89  
90 < Available operators include:
90 > The following is a list of the available operators.  The [a, b] should be
91 > replace in a statement with 'a..b'::bioseg or bioseg_create(a, b).
92  
93   [a, b] && [c, d]        Overlaps
94  
# Line 163 | Line 175
175   This will compile and install the implementation for the "bioseg0" type.
176   The "0" in the name being a mnemonic for "0-based".
177  
178 < Then restart PostgreSQL and run:
179 <    psql -d databasename < bioseg.sql
180 < as usual to install the type in the database.
178 > Then restart PostgreSQL and read "bioseg0.sql":
179 >    psql -d databasename < bioseg0.sql
180 > as to install the type in a database.
181  
182   Note
183   ----
# Line 192 | Line 204
204  
205   Note from the author: Most of the code and all of the hard work needed to
206   implement BIOSEG was by Gene Selkov, Jr, author of the SEG type (contrib/seg
207 < in the PostgreSQL source).  All bugs are due to me.
207 > in the PostgreSQL source).  All bugs are due to me (kmr).
208  
209  
210   AUTHOR
211   ======
212  
213   Kim Rutherford <kmr@flymine.org>
214 +
215 + SEG code by Gene Selkov, Jr.
216 +

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines