Merge pull request #645 from knocte/nitpicks
[mono.git] / mcs / class / corlib / Mono.Math.Prime.Generator / PrimeGeneratorBase.cs
1 //
2 // Mono.Math.Prime.Generator.PrimeGeneratorBase.cs - Abstract Prime Generator
3 //
4 // Authors:
5 //      Ben Maurer
6 //
7 // Copyright (c) 2003 Ben Maurer. All rights reserved
8 //
9
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
18 // 
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
21 // 
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 //
30
31 using System;
32
33 namespace Mono.Math.Prime.Generator {
34
35 #if INSIDE_CORLIB
36         internal
37 #else
38         public
39 #endif
40         abstract class PrimeGeneratorBase {
41
42                 public virtual ConfidenceFactor Confidence {
43                         get {
44 #if DEBUG
45                                 return ConfidenceFactor.ExtraLow;
46 #else
47                                 return ConfidenceFactor.Medium;
48 #endif
49                         }
50                 }
51
52                 public virtual Prime.PrimalityTest PrimalityTest {
53                         get {
54                                 return new Prime.PrimalityTest (PrimalityTests.RabinMillerTest);
55                         }
56                 }
57
58                 public virtual int TrialDivisionBounds {
59                         get { return 4000; }
60                 }
61
62                 /// <summary>
63                 /// Performs primality tests on bi, assumes trial division has been done.
64                 /// </summary>
65                 /// <param name="bi">A BigInteger that has been subjected to and passed trial division</param>
66                 /// <returns>False if bi is composite, true if it may be prime.</returns>
67                 /// <remarks>The speed of this method is dependent on Confidence</remarks>
68                 protected bool PostTrialDivisionTests (BigInteger bi)
69                 {
70                         return PrimalityTest (bi, this.Confidence);
71                 }
72
73                 public abstract BigInteger GenerateNewPrime (int bits);
74         }
75 }