DRC doc update

KLayout · Aug 14, 2024 · a8bedf7 · a8bedf7
1 parent 9f16f07
commit a8bedf7
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 27 deletions.
diff --git a/src/doc/doc/about/drc_ref.xml b/src/doc/doc/about/drc_ref.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/drc_ref_drc.xml b/src/doc/doc/about/drc_ref_drc.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/drc_ref_global.xml b/src/doc/doc/about/drc_ref_global.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/drc_ref_layer.xml b/src/doc/doc/about/drc_ref_layer.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>
@@ -1448,7 +1448,7 @@ pl = polygon_layer
 pl.insert(box(0.0, 0.0, 100.0, 200.0)
 </pre>
 </p>
-<a name="inside"/><h2>"inside" - Selects edges or polygons of self which are inside edges or polygons from the other layer</h2>
+<a name="inside"/><h2>"inside" - Selects edges, edge pairs or polygons of self which are inside edges or polygons from the other layer</h2>
 <keyword name="inside"/>
 <p>Usage:</p>
 <ul>
@@ -1459,6 +1459,10 @@ If layer is a polygon layer, the other layer needs to be a polygon layer too.
 In this case, this method selects all polygons which are completely inside 
 polygons from the other layer.
 </p><p>
+If layer is an edge pair layer, the other layer needs to be a polygon layer.
+In this case, this method selects all edge pairs which are completely inside 
+polygons from the other layer.
+</p><p>
 If layer is an edge layer, the other layer can be polygon or edge layer. In the
 first case, all edges completely inside the polygons from the other layer are
 selected. If the other layer is an edge layer, all edges completely contained 
@@ -1548,7 +1552,7 @@ otherwise individual shapes are selected.
 It returns a new layer containing the selected shapes. A version which modifies self
 is <a href="#select_interacting">select_interacting</a>.
 </p><p>
-This method is available for polygon, text and edge layers. Edges can be selected
+This method is available for polygon, text, edge and edge pair layers. Edges and edge pairs can be selected
 with respect to other edges or polygons. Texts can be selected with respect to 
 polygons. Polygons can be selected with respect to edges, texts and other polygons.
 </p><p>
@@ -1846,6 +1850,7 @@ The following images shows the effect of the "moved" method:
 <ul>
 <li><tt>layer.nets</tt></li>
 <li><tt>layer.nets(net_filter)</tt></li>
+<li><tt>layer.nets(net_object)</tt></li>
 <li><tt>layer.nets(circuit_filter, net_filter)</tt></li>
 <li><tt>layer.nets(netter, ...)</tt></li>
 <li><tt>layer.nets(prop(key), ...)</tt></li>
@@ -1863,7 +1868,7 @@ A glob-style name pattern can be supplied to filter nets. Nets are always
 complete - subnets from subcircuits are not selected. The net name is taken from
 the net's home circuit (to topmost location where all net connections are formed).
 You can specify a circuit filter to select nets from certain circuits only or
-give a <class_doc href="Circuit">Circuit</class_doc> object explicitly. 
+give a <class_doc href="Circuit">Circuit</class_doc> object explicitly. You can also specify <class_doc href="Net">Net</class_doc> objects directly.
 </p><p>
 <pre>
 connect(metal1, via1)
@@ -2024,14 +2029,14 @@ The following image shows the effect of the "not_in" method (input1: red, input2
 </tr>
 </table>
 </p>
-<a name="not_inside"/><h2>"not_inside" - Selects edges or polygons of self which are not inside edges or polygons from the other layer</h2>
+<a name="not_inside"/><h2>"not_inside" - Selects edges, edge pairs or polygons of self which are not inside edges or polygons from the other layer</h2>
 <keyword name="not_inside"/>
 <p>Usage:</p>
 <ul>
 <li><tt>layer.not_inside(other)</tt></li>
 </ul>
 <p>
-This method computes the inverse of <a href="#inside">inside</a> - i.e. edges or polygons from the layer
+This method computes the inverse of <a href="#inside">inside</a> - i.e. edge, edge pairs or polygons from the layer
 not being inside polygons or edges from the other layer. 
 </p><p>
 This method returns a new layer containing the selected shapes. A version which modifies self
@@ -2080,7 +2085,7 @@ otherwise individual shapes are selected.
 It returns a new layer containing the selected shapes. A version which modifies self
 is <a href="#select_not_interacting">select_not_interacting</a>.
 </p><p>
-This method is available for polygon, text and edge layers. Edges can be selected
+This method is available for polygon, text, edge and edge pair layers. Edges and edge pairs can be selected
 with respect to other edges or polygons. Texts can be selected with respect to 
 polygons. Polygons can be selected with respect to edges, texts and other polygons.
 </p><p>
@@ -2108,14 +2113,14 @@ from the other layer. Two polygons overlapping or touching at two locations are
 </tr>
 </table>
 </p>
-<a name="not_outside"/><h2>"not_outside" - Selects edges or polygons of self which are not outside edges or polygons from the other layer</h2>
+<a name="not_outside"/><h2>"not_outside" - Selects edges, edge pairs or polygons of self which are not outside edges or polygons from the other layer</h2>
 <keyword name="not_outside"/>
 <p>Usage:</p>
 <ul>
 <li><tt>layer.not_outside(other)</tt></li>
 </ul>
 <p>
-This method computes the inverse of <a href="#outside">outside</a> - i.e. edges or polygons from the layer
+This method computes the inverse of <a href="#outside">outside</a> - i.e. edges, edge pairs or polygons from the layer
 not being outside polygons or edges from the other layer. 
 </p><p>
 This method returns a new layer containing the selected shapes. A version which modifies self
@@ -2289,7 +2294,7 @@ check2.output("Check 2", second_report)
 check3.output("Check 3")
 </pre>
 </p>
-<a name="outside"/><h2>"outside" - Selects edges or polygons of self which are outside edges or polygons from the other layer</h2>
+<a name="outside"/><h2>"outside" - Selects edges, edge pairs or polygons of self which are outside edges or polygons from the other layer</h2>
 <keyword name="outside"/>
 <p>Usage:</p>
 <ul>
@@ -2300,6 +2305,10 @@ If layer is a polygon layer, the other layer needs to be a polygon layer too.
 In this case, this method selects all polygons which are entirely outside 
 polygons from the other layer.
 </p><p>
+If layer is an edge pair layer, the other layer needs to be a polygon layer.
+In this case, this method selects all edge pairs which are entirely outside 
+polygons from the other layer.
+</p><p>
 If layer is an edge layer, the other layer can be polygon or edge layer. In the
 first case, all edges entirely outside the polygons from the other layer are
 selected. If the other layer is an edge layer, all edges entirely outside
@@ -2501,7 +2510,7 @@ provides a way to pull shapes from other to the hierarchy to self.
 </p><p>
 This method will neither modify self nor other.
 </p><p>
-This method is available for polygon, edge and text layers, similar to interacting.
+This method is available for polygon, edge, edge pair and text layers, similar to interacting.
 </p>
 <a name="pull_overlapping"/><h2>"pull_overlapping" - Selects shapes or regions of other which overlap shapes from the this region</h2>
 <keyword name="pull_overlapping"/>
@@ -2720,7 +2729,7 @@ is <a href="#covering">covering</a>.
 </p><p>
 This method is available for polygons only.
 </p>
-<a name="select_inside"/><h2>"select_inside" - Selects edges or polygons of self which are inside edges or polygons from the other layer</h2>
+<a name="select_inside"/><h2>"select_inside" - Selects edges, edge pairs or polygons of self which are inside edges or polygons from the other layer</h2>
 <keyword name="select_inside"/>
 <p>Usage:</p>
 <ul>
@@ -2746,7 +2755,7 @@ otherwise individual shapes are selected.
 It modifies self to contain the selected shapes. A version which does not modify self
 is <a href="#interacting">interacting</a>.
 </p><p>
-This method is available for polygon, text and edge layers. Edges can be selected
+This method is available for polygon, text, edge and edge pair layers. Edges and edge pairs can be selected
 with respect to other edges or polygons. Texts can be selected with respect to 
 polygons. Polygons can be selected with respect to edges, texts and other polygons.
 </p><p>
@@ -2773,7 +2782,7 @@ is <a href="#not_covering">not_covering</a>.
 </p><p>
 This method is available for polygons only.
 </p>
-<a name="select_not_inside"/><h2>"select_not_inside" - Selects edges or polygons of self which are not inside edges or polygons from the other layer</h2>
+<a name="select_not_inside"/><h2>"select_not_inside" - Selects edges, edge pairs or polygons of self which are not inside edges or polygons from the other layer</h2>
 <keyword name="select_not_inside"/>
 <p>Usage:</p>
 <ul>
@@ -2799,7 +2808,7 @@ otherwise individual shapes are selected.
 It modifies self to contain the selected shapes. A version which does not modify self
 is <a href="#not_interacting">not_interacting</a>.
 </p><p>
-This method is available for polygon, text and edge layers. Edges can be selected
+This method is available for polygon, text, edge and edge pair layers. Edges or edge pairs can be selected
 with respect to other edges or polygons. Texts can be selected with respect to 
 polygons. Polygons can be selected with respect to edges, texts and other polygons.
 </p><p>
@@ -2808,7 +2817,7 @@ number of (different) shapes from the other layer. If a min and max count is giv
 self are selected only if they interact with less than min_count or more than max_count different shapes
 from the other layer. Two polygons overlapping or touching at two locations are counted as single interactions.
 </p>
-<a name="select_not_outside"/><h2>"select_not_outside" - Selects edges or polygons of self which are not outside edges or polygons from the other layer</h2>
+<a name="select_not_outside"/><h2>"select_not_outside" - Selects edges, edge pairs or polygons of self which are not outside edges or polygons from the other layer</h2>
 <keyword name="select_not_outside"/>
 <p>Usage:</p>
 <ul>
@@ -2836,7 +2845,7 @@ is <a href="#not_overlapping">not_overlapping</a>.
 </p><p>
 This method is available for polygons only.
 </p>
-<a name="select_outside"/><h2>"select_outside" - Selects edges or polygons of self which are outside edges or polygons from the other layer</h2>
+<a name="select_outside"/><h2>"select_outside" - Selects edges, edge pairs or polygons of self which are outside edges or polygons from the other layer</h2>
 <keyword name="select_outside"/>
 <p>Usage:</p>
 <ul>
@@ -3278,7 +3287,7 @@ The options of this method are the same than <a href="#covering">covering</a>.
 <li><tt>(a, b) = layer.split_inside(other)</tt></li>
 </ul>
 <p>
-This method returns the polygons or edges inside of polygons or edges from the other layer in 
+This method returns the polygons, edge pairs or edges inside of polygons or edges from the other layer in 
 one layer and all others in a second layer. This method is equivalent to calling 
 <a href="#inside">inside</a> and <a href="#not_inside">not_inside</a>, but is faster than doing this in separate steps:
 </p><p>
@@ -3310,7 +3319,7 @@ The options of this method are the same than <a href="#interacting">interacting<
 <li><tt>(a, b) = layer.split_outside(other)</tt></li>
 </ul>
 <p>
-This method returns the polygons or edges outside of polygons or edges from the other layer in 
+This method returns the polygons, edge pairs or edges outside of polygons or edges from the other layer in 
 one layer and all others in a second layer. This method is equivalent to calling 
 <a href="#outside">outside</a> and <a href="#not_outside">not_outside</a>, but is faster than doing this in separate steps:
 </p><p>

diff --git a/src/doc/doc/about/drc_ref_netter.xml b/src/doc/doc/about/drc_ref_netter.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/drc_ref_source.xml b/src/doc/doc/about/drc_ref_source.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/lvs_ref.xml b/src/doc/doc/about/lvs_ref.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/lvs_ref_global.xml b/src/doc/doc/about/lvs_ref_global.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>

diff --git a/src/doc/doc/about/lvs_ref_netter.xml b/src/doc/doc/about/lvs_ref_netter.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE language SYSTEM "klayout_doc.dtd">
 
-<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb  -->
+<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb  -->
 <!-- DO NOT EDIT! -->
 
 <doc>