KiCad PCB EDA Suite
ratsnest_data.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KICAD, a free EDA CAD application.
3 *
4 * Copyright (C) 2013-2017 CERN
5 * Copyright (C) 2019-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Maciej Suminski <[email protected]>
8 * @author Tomasz Wlostowski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
33#ifdef PROFILE
34#include <profile.h>
35#endif
36
38#include <functional>
39using namespace std::placeholders;
40
41#include <algorithm>
42#include <cassert>
43#include <limits>
44
45#include <delaunator.hpp>
46
48{
49
50public:
51 disjoint_set( size_t size )
52 {
53 m_data.resize( size );
54 m_depth.resize( size, 0 );
55
56 for( size_t i = 0; i < size; i++ )
57 m_data[i] = i;
58 }
59
60 int find( int aVal )
61 {
62 int root = aVal;
63
64 while( m_data[root] != root )
65 root = m_data[root];
66
67 // Compress the path
68 while( m_data[aVal] != aVal )
69 {
70 auto& tmp = m_data[aVal];
71 aVal = tmp;
72 tmp = root;
73 }
74
75 return root;
76 }
77
78
79 bool unite( int aVal1, int aVal2 )
80 {
81 aVal1 = find( aVal1 );
82 aVal2 = find( aVal2 );
83
84 if( aVal1 != aVal2 )
85 {
86 if( m_depth[aVal1] < m_depth[aVal2] )
87 {
88 m_data[aVal1] = aVal2;
89 }
90 else
91 {
92 m_data[aVal2] = aVal1;
93
94 if( m_depth[aVal1] == m_depth[aVal2] )
95 m_depth[aVal1]++;
96 }
97
98 return true;
99 }
100
101 return false;
102 }
103
104private:
105 std::vector<int> m_data;
106 std::vector<int> m_depth;
107};
108
109
110void RN_NET::kruskalMST( const std::vector<CN_EDGE> &aEdges )
111{
112 disjoint_set dset( m_nodes.size() );
113
114 m_rnEdges.clear();
115
116 int i = 0;
117
118 for( const std::shared_ptr<CN_ANCHOR>& node : m_nodes )
119 node->SetTag( i++ );
120
121 for( const CN_EDGE& tmp : aEdges )
122 {
123 const std::shared_ptr<CN_ANCHOR>& source = tmp.GetSourceNode();
124 const std::shared_ptr<CN_ANCHOR>& target = tmp.GetTargetNode();
125
126 if( dset.unite( source->GetTag(), target->GetTag() ) )
127 {
128 if( tmp.GetWeight() > 0 )
129 m_rnEdges.push_back( tmp );
130 }
131 }
132}
133
134
136{
137private:
138 std::multiset<std::shared_ptr<CN_ANCHOR>, CN_PTR_CMP> m_allNodes;
139
140
141 // Checks if all nodes in aNodes lie on a single line. Requires the nodes to
142 // have unique coordinates!
143 bool areNodesColinear( const std::vector<std::shared_ptr<CN_ANCHOR>>& aNodes ) const
144 {
145 if ( aNodes.size() <= 2 )
146 return true;
147
148 const VECTOR2I p0( aNodes[0]->Pos() );
149 const VECTOR2I v0( aNodes[1]->Pos() - p0 );
150
151 for( unsigned i = 2; i < aNodes.size(); i++ )
152 {
153 const VECTOR2I v1 = aNodes[i]->Pos() - p0;
154
155 if( v0.Cross( v1 ) != 0 )
156 return false;
157 }
158
159 return true;
160 }
161
162public:
163
164 void Clear()
165 {
166 m_allNodes.clear();
167 }
168
169 void AddNode( std::shared_ptr<CN_ANCHOR> aNode )
170 {
171 m_allNodes.insert( aNode );
172 }
173
174 void Triangulate( std::vector<CN_EDGE>& mstEdges )
175 {
176 std::vector<double> node_pts;
177 std::vector<std::shared_ptr<CN_ANCHOR>> anchors;
178 std::vector< std::vector<std::shared_ptr<CN_ANCHOR>> > anchorChains( m_allNodes.size() );
179
180 node_pts.reserve( 2 * m_allNodes.size() );
181 anchors.reserve( m_allNodes.size() );
182
183 auto addEdge =
184 [&]( const std::shared_ptr<CN_ANCHOR>& src, const std::shared_ptr<CN_ANCHOR>& dst )
185 {
186 mstEdges.emplace_back( src, dst, src->Dist( *dst ) );
187 };
188
189 std::shared_ptr<CN_ANCHOR> prev = nullptr;
190
191 for( const std::shared_ptr<CN_ANCHOR>& n : m_allNodes )
192 {
193 if( !prev || prev->Pos() != n->Pos() )
194 {
195 node_pts.push_back( n->Pos().x );
196 node_pts.push_back( n->Pos().y );
197 anchors.push_back( n );
198 prev = n;
199 }
200
201 anchorChains[anchors.size() - 1].push_back( n );
202 }
203
204 if( anchors.size() < 2 )
205 {
206 return;
207 }
208 else if( areNodesColinear( anchors ) )
209 {
210 // special case: all nodes are on the same line - there's no
211 // triangulation for such set. In this case, we sort along any coordinate
212 // and chain the nodes together.
213 for( size_t i = 0; i < anchors.size() - 1; i++ )
214 addEdge( anchors[i], anchors[i + 1] );
215 }
216 else
217 {
218 delaunator::Delaunator delaunator( node_pts );
219 auto& triangles = delaunator.triangles;
220
221 for( size_t i = 0; i < triangles.size(); i += 3 )
222 {
223 addEdge( anchors[triangles[i]], anchors[triangles[i + 1]] );
224 addEdge( anchors[triangles[i + 1]], anchors[triangles[i + 2]] );
225 addEdge( anchors[triangles[i + 2]], anchors[triangles[i]] );
226 }
227
228 for( size_t i = 0; i < delaunator.halfedges.size(); i++ )
229 {
230 if( delaunator.halfedges[i] == delaunator::INVALID_INDEX )
231 continue;
232
233 addEdge( anchors[triangles[i]], anchors[triangles[delaunator.halfedges[i]]] );
234 }
235 }
236
237 for( size_t i = 0; i < anchorChains.size(); i++ )
238 {
239 std::vector<std::shared_ptr<CN_ANCHOR>>& chain = anchorChains[i];
240
241 if( chain.size() < 2 )
242 continue;
243
244 std::sort( chain.begin(), chain.end(),
245 [] ( const std::shared_ptr<CN_ANCHOR>& a, const std::shared_ptr<CN_ANCHOR>& b )
246 {
247 return a->GetCluster().get() < b->GetCluster().get();
248 } );
249
250 for( unsigned int j = 1; j < chain.size(); j++ )
251 {
252 const std::shared_ptr<CN_ANCHOR>& prevNode = chain[j - 1];
253 const std::shared_ptr<CN_ANCHOR>& curNode = chain[j];
254 int weight = prevNode->GetCluster() != curNode->GetCluster() ? 1 : 0;
255 mstEdges.emplace_back( prevNode, curNode, weight );
256 }
257 }
258 }
259};
260
261
262RN_NET::RN_NET() : m_dirty( true )
263{
265}
266
267
269{
270 // Special cases do not need complicated algorithms (actually, it does not work well with
271 // the Delaunay triangulator)
272 if( m_nodes.size() <= 2 )
273 {
274 m_rnEdges.clear();
275
276 // Check if the only possible connection exists
277 if( m_boardEdges.size() == 0 && m_nodes.size() == 2 )
278 {
279 auto last = ++m_nodes.begin();
280
281 // There can be only one possible connection, but it is missing
282 CN_EDGE edge ( *m_nodes.begin(), *last );
283 edge.GetSourceNode()->SetTag( 0 );
284 edge.GetTargetNode()->SetTag( 1 );
285
286 m_rnEdges.push_back( edge );
287 }
288 else
289 {
290 // Set tags to m_nodes as connected
291 for( const std::shared_ptr<CN_ANCHOR>& node : m_nodes )
292 node->SetTag( 0 );
293 }
294
295 return;
296 }
297
298
299 m_triangulator->Clear();
300
301 for( const std::shared_ptr<CN_ANCHOR>& n : m_nodes )
302 m_triangulator->AddNode( n );
303
304 std::vector<CN_EDGE> triangEdges;
305 triangEdges.reserve( m_nodes.size() + m_boardEdges.size() );
306
307#ifdef PROFILE
308 PROF_TIMER cnt( "triangulate" );
309#endif
310 m_triangulator->Triangulate( triangEdges );
311#ifdef PROFILE
312 cnt.Show();
313#endif
314
315 for( const CN_EDGE& e : m_boardEdges )
316 triangEdges.emplace_back( e );
317
318 std::sort( triangEdges.begin(), triangEdges.end() );
319
320// Get the minimal spanning tree
321#ifdef PROFILE
322 PROF_TIMER cnt2( "mst" );
323#endif
324 kruskalMST( triangEdges );
325#ifdef PROFILE
326 cnt2.Show();
327#endif
328}
329
330
332{
333 auto findZoneAnchor =
334 [&]( const VECTOR2I& aPos, const LSET& aLayerSet,
335 const std::shared_ptr<CN_ANCHOR> aAnchor )
336 {
337 SEG::ecoord closest_dist_sq = ( aAnchor->Pos() - aPos ).SquaredEuclideanNorm();
338 VECTOR2I closest_pt;
339 CN_ITEM* closest_item = nullptr;
340
341 for( CN_ITEM* item : aAnchor->Item()->ConnectedItems() )
342 {
343 CN_ZONE_LAYER* zoneLayer = dynamic_cast<CN_ZONE_LAYER*>( item );
344
345 if( zoneLayer && aLayerSet.test( zoneLayer->Layer() ) )
346 {
347 const std::vector<VECTOR2I>& pts = zoneLayer->GetOutline().CPoints();
348
349 for( VECTOR2I pt : pts )
350 {
351 SEG::ecoord dist_sq = ( pt - aPos ).SquaredEuclideanNorm();
352
353 if( dist_sq < closest_dist_sq )
354 {
355 closest_pt = pt;
356 closest_item = zoneLayer;
357 closest_dist_sq = dist_sq;
358 }
359 }
360 }
361 }
362
363 if( closest_item )
364 {
365 closest_item->AddAnchor( closest_pt );
366 return closest_item->GetAnchorItem( closest_item->GetAnchorItemCount() - 1 );
367 }
368
369 return aAnchor;
370 };
371
372 auto findZoneToZoneAnchors =
373 [&]( std::shared_ptr<CN_ANCHOR>& a, std::shared_ptr<CN_ANCHOR>& b )
374 {
375 for( CN_ITEM* itemA : a->Item()->ConnectedItems() )
376 {
377 CN_ZONE_LAYER* zoneLayerA = dynamic_cast<CN_ZONE_LAYER*>( itemA );
378
379 if( !zoneLayerA )
380 continue;
381
382 for( CN_ITEM* itemB : b->Item()->ConnectedItems() )
383 {
384 CN_ZONE_LAYER* zoneLayerB = dynamic_cast<CN_ZONE_LAYER*>( itemB );
385
386 if( zoneLayerB && zoneLayerB->Layer() == zoneLayerA->Layer() )
387 {
388 // Process the first matching layer. We don't really care if it's
389 // the "best" layer or not, as anything will be better than the
390 // original anchors (which are connected to the zone and so certainly
391 // don't look like they should have ratsnest lines coming off them).
392
393 VECTOR2I startA = zoneLayerA->GetOutline().GetPoint( 0 );
394 VECTOR2I startB = zoneLayerB->GetOutline().GetPoint( 0 );
395 const SHAPE* shapeA = &zoneLayerA->GetOutline();
396 const SHAPE* shapeB = &zoneLayerB->GetOutline();
397 int startDist = ( startA - startB ).EuclideanNorm();
398
399 VECTOR2I ptA;
400 shapeA->Collide( shapeB, startDist + 10, nullptr, &ptA );
401 zoneLayerA->AddAnchor( ptA );
402 a = zoneLayerA->GetAnchorItem( zoneLayerA->GetAnchorItemCount() - 1 );
403
404 VECTOR2I ptB;
405 shapeB->Collide( shapeA, startDist + 10, nullptr, &ptB );
406 zoneLayerB->AddAnchor( ptB );
407 b = zoneLayerB->GetAnchorItem( zoneLayerB->GetAnchorItemCount() - 1 );
408
409 return;
410 }
411 }
412 }
413 };
414
415 for( CN_EDGE& edge : m_rnEdges )
416 {
417 std::shared_ptr<CN_ANCHOR> source = edge.GetSourceNode();
418 std::shared_ptr<CN_ANCHOR> target = edge.GetTargetNode();
419
420 if( source->ConnectedItemsCount() == 0 )
421 {
422 edge.SetTargetNode( findZoneAnchor( source->Pos(), source->Parent()->GetLayerSet(),
423 target ) );
424 }
425 else if( target->ConnectedItemsCount() == 0 )
426 {
427 edge.SetSourceNode( findZoneAnchor( target->Pos(), target->Parent()->GetLayerSet(),
428 source ) );
429 }
430 else
431 {
432 findZoneToZoneAnchors( source, target );
433 edge.SetSourceNode( source );
434 edge.SetTargetNode( target );
435 }
436 }
437}
438
439
441{
442 compute();
443
444#ifdef PROFILE
445 PROF_TIMER cnt( "optimize" );
446#endif
448#ifdef PROFILE
449 cnt.Show();
450#endif
451
452 m_dirty = false;
453}
454
455
457{
458 m_rnEdges.clear();
459 m_boardEdges.clear();
460 m_nodes.clear();
461
462 m_dirty = true;
463}
464
465
466void RN_NET::AddCluster( std::shared_ptr<CN_CLUSTER> aCluster )
467{
468 std::shared_ptr<CN_ANCHOR> firstAnchor;
469
470 for( CN_ITEM* item : *aCluster )
471 {
472 std::vector<std::shared_ptr<CN_ANCHOR>>& anchors = item->Anchors();
473 unsigned int nAnchors = dynamic_cast<CN_ZONE_LAYER*>( item ) ? 1 : anchors.size();
474
475 if( nAnchors > anchors.size() )
476 nAnchors = anchors.size();
477
478 for( unsigned int i = 0; i < nAnchors; i++ )
479 {
480 anchors[i]->SetCluster( aCluster );
481 m_nodes.insert( anchors[i] );
482
483 if( firstAnchor )
484 {
485 if( firstAnchor != anchors[i] )
486 m_boardEdges.emplace_back( firstAnchor, anchors[i], 0 );
487 }
488 else
489 {
490 firstAnchor = anchors[i];
491 }
492 }
493 }
494}
495
496
497bool RN_NET::NearestBicoloredPair( RN_NET* aOtherNet, VECTOR2I& aPos1, VECTOR2I& aPos2 ) const
498{
499 bool rv = false;
500
502
503 auto verify =
504 [&]( const std::shared_ptr<CN_ANCHOR>& aTestNode1,
505 const std::shared_ptr<CN_ANCHOR>& aTestNode2 )
506 {
507 VECTOR2I diff = aTestNode1->Pos() - aTestNode2->Pos();
508 SEG::ecoord dist_sq = diff.SquaredEuclideanNorm();
509
510 if( dist_sq < distMax_sq )
511 {
512 rv = true;
513 distMax_sq = dist_sq;
514 aPos1 = aTestNode1->Pos();
515 aPos2 = aTestNode2->Pos();
516 }
517 };
518
519 std::multiset<std::shared_ptr<CN_ANCHOR>, CN_PTR_CMP> nodes_b;
520
521 std::copy_if( m_nodes.begin(), m_nodes.end(), std::inserter( nodes_b, nodes_b.end() ),
522 []( const std::shared_ptr<CN_ANCHOR> &aVal )
523 { return !aVal->GetNoLine(); } );
524
528 for( const std::shared_ptr<CN_ANCHOR>& nodeA : aOtherNet->m_nodes )
529 {
530
531 if( nodeA->GetNoLine() )
532 continue;
533
537 auto fwd_it = nodes_b.lower_bound( nodeA );
538 auto rev_it = std::make_reverse_iterator( fwd_it );
539
540 for( ; fwd_it != nodes_b.end(); ++fwd_it )
541 {
542 const std::shared_ptr<CN_ANCHOR>& nodeB = *fwd_it;
543
544 SEG::ecoord distX_sq = SEG::Square( nodeA->Pos().x - nodeB->Pos().x );
545
548 if( distX_sq > distMax_sq )
549 break;
550
551 verify( nodeA, nodeB );
552 }
553
555 for( ; rev_it != nodes_b.rend(); ++rev_it )
556 {
557 const std::shared_ptr<CN_ANCHOR>& nodeB = *rev_it;
558
559 SEG::ecoord distX_sq = SEG::Square( nodeA->Pos().x - nodeB->Pos().x );
560
561 if( distX_sq > distMax_sq )
562 break;
563
564 verify( nodeA, nodeB );
565 }
566 }
567
568 return rv;
569}
570
CN_EDGE represents a point-to-point connection, whether realized or unrealized (ie: tracks etc.
std::shared_ptr< CN_ANCHOR > GetTargetNode() const
std::shared_ptr< CN_ANCHOR > GetSourceNode() const
CN_ITEM represents a BOARD_CONNETED_ITEM in the connectivity system (ie: a pad, track/arc/via,...
virtual int Layer() const
Return the item's layer, for single-layered items only.
std::shared_ptr< CN_ANCHOR > GetAnchorItem(int n) const
int GetAnchorItemCount() const
const std::vector< CN_ITEM * > & ConnectedItems() const
void AddAnchor(const VECTOR2I &aPos)
const SHAPE_LINE_CHAIN & GetOutline() const
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:530
A small class to help profiling.
Definition: profile.h:47
void Show(std::ostream &aStream=std::cerr)
Print the elapsed time (in a suitable unit) to a stream.
Definition: profile.h:103
std::multiset< std::shared_ptr< CN_ANCHOR >, CN_PTR_CMP > m_allNodes
bool areNodesColinear(const std::vector< std::shared_ptr< CN_ANCHOR > > &aNodes) const
void AddNode(std::shared_ptr< CN_ANCHOR > aNode)
void Triangulate(std::vector< CN_EDGE > &mstEdges)
Describe ratsnest for a single net.
Definition: ratsnest_data.h:63
std::shared_ptr< TRIANGULATOR_STATE > m_triangulator
std::multiset< std::shared_ptr< CN_ANCHOR >, CN_PTR_CMP > m_nodes
< Vector of nodes
void kruskalMST(const std::vector< CN_EDGE > &aEdges)
Find optimal ends of RNEdges.
void Update()
Recompute ratsnest for a net.
std::vector< CN_EDGE > m_rnEdges
Flag indicating necessity of recalculation of ratsnest for a net.
bool NearestBicoloredPair(RN_NET *aOtherNet, VECTOR2I &aPos1, VECTOR2I &aPos2) const
bool m_dirty
std::vector< CN_EDGE > m_boardEdges
Vector of edges that makes ratsnest for a given net.
void optimizeRNEdges()
void compute()
< Recompute ratsnest from scratch.
void Clear()
void AddCluster(std::shared_ptr< CN_CLUSTER > aCluster)
VECTOR2I::extended_type ecoord
Definition: seg.h:44
static SEG::ecoord Square(int a)
Definition: seg.h:123
virtual const VECTOR2I GetPoint(int aIndex) const override
const std::vector< VECTOR2I > & CPoints() const
An abstract shape on 2D plane.
Definition: shape.h:123
virtual bool Collide(const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const
Check if the boundary of shape (this) lies closer to the point aP than aClearance,...
Definition: shape.h:178
extended_type SquaredEuclideanNorm() const
Compute the squared euclidean norm of the vector, which is defined as (x ** 2 + y ** 2).
Definition: vector2d.h:300
static constexpr extended_type ECOORD_MAX
Definition: vector2d.h:79
extended_type Cross(const VECTOR2< T > &aVector) const
Compute cross product of self with aVector.
Definition: vector2d.h:487
disjoint_set(size_t size)
std::vector< int > m_data
std::vector< int > m_depth
int find(int aVal)
bool unite(int aVal1, int aVal2)
Class that computes missing connections on a PCB.
v1
double EuclideanNorm(const VECTOR2I &vector)
Definition: trigo.h:129