luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating stubs, DRC documentation

This commit is contained in:
Matthias Koefferlein 2024-09-22 21:11:21 +02:00
parent 4c33032f93
commit a0b8e4bea1
11 changed files with 656 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/doc/doc/about/drc_ref.xml
View File

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

2
src/doc/doc/about/drc_ref_drc.xml
View File

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

26
src/doc/doc/about/drc_ref_global.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>
@ -1110,9 +1110,27 @@ filled with <a href="/about/drc_ref_layer.xml#insert">Layer#insert</a>.
</ul> </ul>
<p> <p>
In deep mode, polygons with a bounding box to polygon area ratio bigger than the given number In deep mode, polygons with a bounding box to polygon area ratio bigger than the given number
will be split into smaller chunks to optimize performance (which gets better if the polygon's will be split into smaller chunks to optimize performance. Performance gets better if the polygon's
bounding boxes do not cover a lot of empty space). bounding boxes do not cover too much of empty space.
The default threshold is 3.0 which means fairly compact polygons. Use this method with a numeric </p><p>
The area ratio is a signed value. Negative values indicate to use the outer
manhattan approximation of the polygons for the area ratio. Positive values indicate to
take the polygons as they are.
The sign of the value indicates the mode - the actual area ratio checked is the absolute value.
</p><p>
For manhattan polygons, an area ratio of -3.0 gives the same results than a positive 3.0.
For non-manhattan polygons and a negative area ratio, the area taken for the polygon is larger than
the actual polygon area. So splitting is less likely in this case. This avoids degeneration
of the polygon assembly, which can otherwise happen for skinny diagonal polygons. These are usually
resolved into a large number of small triangles with no benefit for the algorithms.
</p><p>
With a negative area ratio, triangles are equivalent to their bounding box and always
have an area ratio of 1.0.
</p><p>
The default value is -3.0 which gives fairly compact polygons and is using their outer
manhattan approximation. Skinny diagonals will be maintained.
</p><p>
Use this method with a numeric
argument to set the value and without an argument to get the current maximum area ratio. argument to set the value and without an argument to get the current maximum area ratio.
Set the value to zero to disable splitting by area ratio. Set the value to zero to disable splitting by area ratio.
</p><p> </p><p>

2
src/doc/doc/about/drc_ref_layer.xml
View File

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

2
src/doc/doc/about/drc_ref_netter.xml
View File

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

2
src/doc/doc/about/drc_ref_source.xml
View File

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

2
src/doc/doc/about/lvs_ref.xml
View File

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

2
src/doc/doc/about/lvs_ref_global.xml
View File

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

2
src/doc/doc/about/lvs_ref_netter.xml
View File

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

23
src/drc/drc/built-in-macros/_drc_engine.rb
View File

@ -1296,25 +1296,24 @@ module DRC
# @synopsis max_area_ratio # @synopsis max_area_ratio
# #
# In deep mode, polygons with a bounding box to polygon area ratio bigger than the given number # In deep mode, polygons with a bounding box to polygon area ratio bigger than the given number
# will be split into smaller chunks to optimize performance (which gets better if the polygon's # will be split into smaller chunks to optimize performance. Performance gets better if the polygon's
# bounding boxes do not cover a lot of empty space). # bounding boxes do not cover too much of empty space.
# #
# The area ratio is a signed value. Negative values indicate a area ratio, taking the outer # The area ratio is a signed value. Negative values indicate to use the outer
# manhattan approximation of the polygons for the area ratio. # manhattan approximation of the polygons for the area ratio. Positive values indicate to
# The sign of the value indicates the mode (manhattan approximation or real polygon) - the actual area # take the polygons as they are.
# ratio checked is the absolute value. # The sign of the value indicates the mode - the actual area ratio checked is the absolute value.
# #
# For manhattan polygons, an area ratio of -3.0 gives the same results than a positive 3.0. # For manhattan polygons, an area ratio of -3.0 gives the same results than a positive 3.0.
# For non-manhattan polygons, the area used for the polygon is larger than # For non-manhattan polygons and a negative area ratio, the area taken for the polygon is larger than
# the actual polygon area. So splitting is less likely in these cases. This avoids degeneration # the actual polygon area. So splitting is less likely in this case. This avoids degeneration
# of the split polygon which can otherwise happen for thin diagonal lines. These are often # of the polygon assembly, which can otherwise happen for skinny diagonal polygons. These are usually
# resolved into a large number of small triangles which does not provide any benefit for # resolved into a large number of small triangles with no benefit for the algorithms.
# the algorithms.
# #
# With a negative area ratio, triangles are equivalent to their bounding box and always # With a negative area ratio, triangles are equivalent to their bounding box and always
# have an area ratio of 1.0. # have an area ratio of 1.0.
# #
# The default threshold is -3.0 which gives fairly compact polygons and using their outer # The default value is -3.0 which gives fairly compact polygons and is using their outer
# manhattan approximation. Skinny diagonals will be maintained. # manhattan approximation. Skinny diagonals will be maintained.
# #
# Use this method with a numeric # Use this method with a numeric

717
src/pymod/distutils_src/klayout/dbcore.pyi
View File

File diff suppressed because it is too large Load Diff