gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Better return type for cycleLength() functions (#179) in the min mean cycle algorithms. The original Value type is used instead of the LargeValue type, which is introduced for internal computations.
0 3 0
default
3 files changed with 6 insertions and 6 deletions:
↑ Collapse diff ↑
Ignore white space 96 line context
... ...
@@ -360,98 +360,98 @@
360 360

	
361 361
    /// \brief Find a minimum mean directed cycle.
362 362
    ///
363 363
    /// This function finds a directed cycle of minimum mean length
364 364
    /// in the digraph using the data computed by findMinMean().
365 365
    ///
366 366
    /// \return \c true if a directed cycle exists in the digraph.
367 367
    ///
368 368
    /// \pre \ref findMinMean() must be called before using this function.
369 369
    bool findCycle() {
370 370
      if (!_best_found) return false;
371 371
      IntNodeMap reached(_gr, -1);
372 372
      int r = _best_level + 1;
373 373
      Node u = _best_node;
374 374
      while (reached[u] < 0) {
375 375
        reached[u] = --r;
376 376
        u = _gr.source(_data[u][r].pred);
377 377
      }
378 378
      r = reached[u];
379 379
      Arc e = _data[u][r].pred;
380 380
      _cycle_path->addFront(e);
381 381
      _best_length = _length[e];
382 382
      _best_size = 1;
383 383
      Node v;
384 384
      while ((v = _gr.source(e)) != u) {
385 385
        e = _data[v][--r].pred;
386 386
        _cycle_path->addFront(e);
387 387
        _best_length += _length[e];
388 388
        ++_best_size;
389 389
      }
390 390
      return true;
391 391
    }
392 392

	
393 393
    /// @}
394 394

	
395 395
    /// \name Query Functions
396 396
    /// The results of the algorithm can be obtained using these
397 397
    /// functions.\n
398 398
    /// The algorithm should be executed before using them.
399 399

	
400 400
    /// @{
401 401

	
402 402
    /// \brief Return the total length of the found cycle.
403 403
    ///
404 404
    /// This function returns the total length of the found cycle.
405 405
    ///
406 406
    /// \pre \ref run() or \ref findMinMean() must be called before
407 407
    /// using this function.
408
    LargeValue cycleLength() const {
409
      return _best_length;
408
    Value cycleLength() const {
409
      return static_cast<Value>(_best_length);
410 410
    }
411 411

	
412 412
    /// \brief Return the number of arcs on the found cycle.
413 413
    ///
414 414
    /// This function returns the number of arcs on the found cycle.
415 415
    ///
416 416
    /// \pre \ref run() or \ref findMinMean() must be called before
417 417
    /// using this function.
418 418
    int cycleArcNum() const {
419 419
      return _best_size;
420 420
    }
421 421

	
422 422
    /// \brief Return the mean length of the found cycle.
423 423
    ///
424 424
    /// This function returns the mean length of the found cycle.
425 425
    ///
426 426
    /// \note <tt>alg.cycleMean()</tt> is just a shortcut of the
427 427
    /// following code.
428 428
    /// \code
429 429
    ///   return static_cast<double>(alg.cycleLength()) / alg.cycleArcNum();
430 430
    /// \endcode
431 431
    ///
432 432
    /// \pre \ref run() or \ref findMinMean() must be called before
433 433
    /// using this function.
434 434
    double cycleMean() const {
435 435
      return static_cast<double>(_best_length) / _best_size;
436 436
    }
437 437

	
438 438
    /// \brief Return the found cycle.
439 439
    ///
440 440
    /// This function returns a const reference to the path structure
441 441
    /// storing the found cycle.
442 442
    ///
443 443
    /// \pre \ref run() or \ref findCycle() must be called before using
444 444
    /// this function.
445 445
    const Path& cycle() const {
446 446
      return *_cycle_path;
447 447
    }
448 448

	
449 449
    ///@}
450 450

	
451 451
  private:
452 452

	
453 453
    // Initialization
454 454
    void init() {
455 455
      if (!_cycle_path) {
456 456
        _local_path = true;
457 457
        _cycle_path = new Path;
Ignore white space 96 line context
... ...
@@ -339,98 +339,98 @@
339 339
          findPolicyCycle();
340 340
          if (!computeNodeDistances()) break;
341 341
        }
342 342
        // Update the best cycle (global minimum mean cycle)
343 343
        if ( _curr_found && (!_best_found ||
344 344
             _curr_length * _best_size < _best_length * _curr_size) ) {
345 345
          _best_found = true;
346 346
          _best_length = _curr_length;
347 347
          _best_size = _curr_size;
348 348
          _best_node = _curr_node;
349 349
        }
350 350
      }
351 351
      return _best_found;
352 352
    }
353 353

	
354 354
    /// \brief Find a minimum mean directed cycle.
355 355
    ///
356 356
    /// This function finds a directed cycle of minimum mean length
357 357
    /// in the digraph using the data computed by findMinMean().
358 358
    ///
359 359
    /// \return \c true if a directed cycle exists in the digraph.
360 360
    ///
361 361
    /// \pre \ref findMinMean() must be called before using this function.
362 362
    bool findCycle() {
363 363
      if (!_best_found) return false;
364 364
      _cycle_path->addBack(_policy[_best_node]);
365 365
      for ( Node v = _best_node;
366 366
            (v = _gr.target(_policy[v])) != _best_node; ) {
367 367
        _cycle_path->addBack(_policy[v]);
368 368
      }
369 369
      return true;
370 370
    }
371 371

	
372 372
    /// @}
373 373

	
374 374
    /// \name Query Functions
375 375
    /// The results of the algorithm can be obtained using these
376 376
    /// functions.\n
377 377
    /// The algorithm should be executed before using them.
378 378

	
379 379
    /// @{
380 380

	
381 381
    /// \brief Return the total length of the found cycle.
382 382
    ///
383 383
    /// This function returns the total length of the found cycle.
384 384
    ///
385 385
    /// \pre \ref run() or \ref findMinMean() must be called before
386 386
    /// using this function.
387
    LargeValue cycleLength() const {
388
      return _best_length;
387
    Value cycleLength() const {
388
      return static_cast<Value>(_best_length);
389 389
    }
390 390

	
391 391
    /// \brief Return the number of arcs on the found cycle.
392 392
    ///
393 393
    /// This function returns the number of arcs on the found cycle.
394 394
    ///
395 395
    /// \pre \ref run() or \ref findMinMean() must be called before
396 396
    /// using this function.
397 397
    int cycleArcNum() const {
398 398
      return _best_size;
399 399
    }
400 400

	
401 401
    /// \brief Return the mean length of the found cycle.
402 402
    ///
403 403
    /// This function returns the mean length of the found cycle.
404 404
    ///
405 405
    /// \note <tt>alg.cycleMean()</tt> is just a shortcut of the
406 406
    /// following code.
407 407
    /// \code
408 408
    ///   return static_cast<double>(alg.cycleLength()) / alg.cycleArcNum();
409 409
    /// \endcode
410 410
    ///
411 411
    /// \pre \ref run() or \ref findMinMean() must be called before
412 412
    /// using this function.
413 413
    double cycleMean() const {
414 414
      return static_cast<double>(_best_length) / _best_size;
415 415
    }
416 416

	
417 417
    /// \brief Return the found cycle.
418 418
    ///
419 419
    /// This function returns a const reference to the path structure
420 420
    /// storing the found cycle.
421 421
    ///
422 422
    /// \pre \ref run() or \ref findCycle() must be called before using
423 423
    /// this function.
424 424
    const Path& cycle() const {
425 425
      return *_cycle_path;
426 426
    }
427 427

	
428 428
    ///@}
429 429

	
430 430
  private:
431 431

	
432 432
    // Initialize
433 433
    void init() {
434 434
      if (!_cycle_path) {
435 435
        _local_path = true;
436 436
        _cycle_path = new Path;
Ignore white space 96 line context
... ...
@@ -347,98 +347,98 @@
347 347

	
348 348
    /// \brief Find a minimum mean directed cycle.
349 349
    ///
350 350
    /// This function finds a directed cycle of minimum mean length
351 351
    /// in the digraph using the data computed by findMinMean().
352 352
    ///
353 353
    /// \return \c true if a directed cycle exists in the digraph.
354 354
    ///
355 355
    /// \pre \ref findMinMean() must be called before using this function.
356 356
    bool findCycle() {
357 357
      if (_cycle_node == INVALID) return false;
358 358
      IntNodeMap reached(_gr, -1);
359 359
      int r = _data[_cycle_node].size();
360 360
      Node u = _cycle_node;
361 361
      while (reached[u] < 0) {
362 362
        reached[u] = --r;
363 363
        u = _gr.source(_data[u][r].pred);
364 364
      }
365 365
      r = reached[u];
366 366
      Arc e = _data[u][r].pred;
367 367
      _cycle_path->addFront(e);
368 368
      _cycle_length = _length[e];
369 369
      _cycle_size = 1;
370 370
      Node v;
371 371
      while ((v = _gr.source(e)) != u) {
372 372
        e = _data[v][--r].pred;
373 373
        _cycle_path->addFront(e);
374 374
        _cycle_length += _length[e];
375 375
        ++_cycle_size;
376 376
      }
377 377
      return true;
378 378
    }
379 379

	
380 380
    /// @}
381 381

	
382 382
    /// \name Query Functions
383 383
    /// The results of the algorithm can be obtained using these
384 384
    /// functions.\n
385 385
    /// The algorithm should be executed before using them.
386 386

	
387 387
    /// @{
388 388

	
389 389
    /// \brief Return the total length of the found cycle.
390 390
    ///
391 391
    /// This function returns the total length of the found cycle.
392 392
    ///
393 393
    /// \pre \ref run() or \ref findMinMean() must be called before
394 394
    /// using this function.
395
    LargeValue cycleLength() const {
396
      return _cycle_length;
395
    Value cycleLength() const {
396
      return static_cast<Value>(_cycle_length);
397 397
    }
398 398

	
399 399
    /// \brief Return the number of arcs on the found cycle.
400 400
    ///
401 401
    /// This function returns the number of arcs on the found cycle.
402 402
    ///
403 403
    /// \pre \ref run() or \ref findMinMean() must be called before
404 404
    /// using this function.
405 405
    int cycleArcNum() const {
406 406
      return _cycle_size;
407 407
    }
408 408

	
409 409
    /// \brief Return the mean length of the found cycle.
410 410
    ///
411 411
    /// This function returns the mean length of the found cycle.
412 412
    ///
413 413
    /// \note <tt>alg.cycleMean()</tt> is just a shortcut of the
414 414
    /// following code.
415 415
    /// \code
416 416
    ///   return static_cast<double>(alg.cycleLength()) / alg.cycleArcNum();
417 417
    /// \endcode
418 418
    ///
419 419
    /// \pre \ref run() or \ref findMinMean() must be called before
420 420
    /// using this function.
421 421
    double cycleMean() const {
422 422
      return static_cast<double>(_cycle_length) / _cycle_size;
423 423
    }
424 424

	
425 425
    /// \brief Return the found cycle.
426 426
    ///
427 427
    /// This function returns a const reference to the path structure
428 428
    /// storing the found cycle.
429 429
    ///
430 430
    /// \pre \ref run() or \ref findCycle() must be called before using
431 431
    /// this function.
432 432
    const Path& cycle() const {
433 433
      return *_cycle_path;
434 434
    }
435 435

	
436 436
    ///@}
437 437

	
438 438
  private:
439 439

	
440 440
    // Initialization
441 441
    void init() {
442 442
      if (!_cycle_path) {
443 443
        _local_path = true;
444 444
        _cycle_path = new Path;
0 comments (0 inline)