.ZIP

# Programming Assignment #6 - implement a class called BitArray

Learning objective : To gain experience with bitwise operations, used inside a class. Also will provide further practice with dynamic allocation.

Description:

You will implement a class called BitArray, which will simulate a list of bits of any size, which can be individually set, cleared, flipped, and queried. You will also implement a function that is to be used by a sample test program, which uses the Sieve of Eratosthenes technique (with the bit array) to find prime numbers.

Details

Download these starter files:

bitarray.h -- Seen in Attachment A

main6.cpp -- a sample program for finding prime numbers

The BitArray class

Implement the BitArray class, defining all specified public member functions, in the file bitarray.cpp. Here are some details about the BitArray class:

1. A bit array is to be implemented with an underlying array of type unsigned char. 'Unsigned' because we are only interested in bits, not in negatives, and type char because it is the smallest integer type. The concept of a BitArray object is that it will store an array of bits (in the smallest storage space needed), indexed starting at 0, just like with normal arrays.

2. The array of characters should be created dynamically. The primary constructor has one parameter, which indicates how many bits are needed. The constructor should allocate the minimum number of cells needed for this many bits. Also, have the constructor initialize all bits to 0. Example:

3.

4. BitArray xy(35); // builds storage for at least 35 bits

5. // if we assume 1 byte char, this takes 5

6. // characters, for a total of 40 bits

7. The Length() function should return the total number of bits in the allocated array. In the example above (assuming 1 byte char), this is 40

8. While type char is commonly 8 bits on most machines today, you may not assume that this is always the case. Structure your class so that it is versatile enough to handle different platforms (where type char might differ in size). But always use the minimum number of char elements when creating the array. Hint: sizeof() is a function call that returns the exact number of bytes taken by a variable or type on a given machine:

COP3330 Object Oriented Programming in C/C++

COP3330 Page 2

9. int size = sizeof(int); // tells how many bytes for an int

10. // on current machine

Suggestion: Use a constant to store the size of an unsigned char in the program, for modifiable computations later. If using only inside the class, a static const is best.

11. Because dynamic allocation is used, the BitArray class should implement an appropriate destructor, copy constructor, and assignment operator (for deep copy and appropriate cleanup)

12. The functions Set(), Unset(), Flip(), and Query() represent the different things that can be done with one bit. Each function takes in an index number -- the index of the bit in question.

o Set() should set that bit to 1, without affecting any others

o Unset() should set that bit to 0, without affecting any others

o Flip() should change that bit to its opposite, without affecting any others

o Query() should return true if that bit is currently 1, and it should return false if that bit is currently 0

13. The operator overloads:

o operator<< -- the insertion operator should be written to do output of a BitArray object. Format is the entire array, printed as one continuous sequence of bits, inside parintheses. See example outputs from test program

o operator== and operator!= -- usual inequality operators. Entire arrays must match for them to be equal

14. General:

o You may add private functions to the class if you like, and you may add private constants. You may not change the public interface or the underlying storage (dynamic array of unsigned char).

o Note that NOT ALL features of the BitArray class are tested in the provided main7.cpp sample program. It is up to you to test all BitArray features.

Sieve of Eratosthenes

A common algorithm to find prime numbers is the Sieve of Eratosthenes. A description of algorithm can be found at the following link: (http://en.wikipedia.org/wiki/Sieve_of_Eratosthenes ) The main6.cpp program provided already sets up a BitArray object of desired size. Then it calls upon a function named Sieve.

Write the Sieve() function in a file called sieve.h. Do not change main6.cpp in any way. The Sieve() function should follow the Sieve of Eratosthenes pattern. The general algorithm is as follows:

1. Start by initializing all bits in the array to 1.

2. Each index of the bit array will represent one non-negative integer. Your algorithm should mark all non-prime numbers by setting these bits back to 0, proceeding as follows:

o 0 and 1 are never prime. Unset these bits to 0

o The next "uncleared" bit is prime. Leave this bit as a 1, but change all multiples of this value (not counting itself) to 0

o Move to the next "uncleared" bit and repeat

o This process only needs to repeat up to the square root of the array's length. (Example: If we are checking for the prime numbers from 0 through 500, then we can stop when we've reached sqrt(500), which is 22.36. Once we've reached an "uncleared" bit that is 23 or more, we know we've cleared all the non-primes

3. The remaining bits (which are still 1) indicate the primes.

COP3330 Object Oriented Programming in C/C++

COP3330 Page 3

You can find the sqrt() (square root) function in the library <cmath.

Submitting

Submit the files:

bitarray.h

bitarray.cpp

sieve.h

Grading Criteria:

The program compiles. If the program does not compile no further grading can be accomplished. Programs that do not compile will receive a zero.

(25 Points) The program executes without exception and produces output. The grading of the output cannot be accomplished unless the program executes.

(25 Points) The program produces the correct output.

(25 Points) The program specifications are followed.

(10 Points)The program is documented (commented) properly.

(5 Points)Use constants when values are not to be changed

(5 Points)Use proper indentation

(5 Points)Use good naming standards

COP3330 Object Oriented Programming in C/C++

COP3330 Page 4

Sample Runs

These are sample runs of the main6.cpp program, the Sieve program to find primes. Remember to write your own driver(s) to test other functions in class BitArray (such as comparison operators, copy constructor, etc).

Note that in the sample runs, the bit array really is printing on one line -- but it will probably show on screen wrapped around to multiple lines.

Sample run 1

Enter a positive integer for the maximum value: 345

The bit array looks like this:

(0011010100010100010100010000010100000100010100010000010000010100000100010100000

10001000001000000010001010001010001000000000000010001000001010000000001010000010

00001000100000100000101000000000101000101000000000001000000000001000101000100000

10100000000010000010000010000010100000100010100000000010000000000000100010100010

000000000000100000100000000010100)

Primes less than 345:

2 3 5 7 11 13 17 19

23 29 31 37 41 43 47 53

59 61 67 71 73 79 83 89

97 101 103 107 109 113 127 131

137 139 149 151 157 163 167 173

179 181 191 193 197 199 211 223

227 229 233 239 241 251 257 263

269 271 277 281 283 293 307 311

313 317 331 337

Goodbye!

Sample run 2

Enter a positive integer for the maximum value: 800

The bit array looks like this:

(0011010100010100010100010000010100000100010100010000010000010100000100010100000

10001000001000000010001010001010001000000000000010001000001010000000001010000010

00001000100000100000101000000000101000101000000000001000000000001000101000100000

10100000000010000010000010000010100000100010100000000010000000000000100010100010

00000000000010000010000000001010001000001000000010000010000010001000001000000010

00100000001000000000101000000000101000001000100000100000001000101000100000000000

10000000100010000000100010000010000000000010100000000000000000100000100000000010

00001000001010000010000000001000001000001010000010000010001010000000000010000000

00101000100000100000101000000000001000100000100000001000000000100000001000000000

10000000100000100000100010000000100000100010000000100010000000000000100000000010

0)

COP3330 Object Oriented Programming in C/C++

COP3330 Page 5

Primes less than 800:

2 3 5 7 11 13 17 19

23 29 31 37 41 43 47 53

59 61 67 71 73 79 83 89

97 101 103 107 109 113 127 131

137 139 149 151 157 163 167 173

179 181 191 193 197 199 211 223

227 229 233 239 241 251 257 263

269 271 277 281 283 293 307 311

313 317 331 337 347 349 353 359

367 373 379 383 389 397 401 409

419 421 431 433 439 443 449 457

461 463 467 479 487 491 499 503

509 521 523 541 547 557 563 569

571 577 587 593 599 601 607 613

617 619 631 641 643 647 653 659

661 673 677 683 691 701 709 719

727 733 739 743 751 757 761 769

773 787 797

Goodbye!

COP3330 Object Oriented Programming in C/C++

COP3330 Page 6

Appendix A: bitarray.h

// bitarray.h

//

// BitArray class declaration

#ifndef _BITARRAY_H

#define _BITARRAY_H

#include <iostream

using namespace std;

class BitArray

{

friend ostream& operator<< (ostream& os, const BitArray& a);

friend bool operator== (const BitArray&, const BitArray&);

friend bool operator!= (const BitArray&, const BitArray&);

public:

BitArray(unsigned int n); // Construct an array that can handle n bits

BitArray(const BitArray&); // copy constructor

~BitArray(); // destructor

BitArray& operator= (const BitArray& a); // assignment operator

unsigned int Length() const; // return number of bits in bitarray

void Set (unsigned int index); // set bit with given index to 1

void Unset (unsigned int index); // set bit with given index to 0

void Flip (unsigned int index); // change bit (with given index)

bool Query (unsigned int index) const; // return true if the given bit

// is set to 1, false otherwise

private:

unsigned char* barray; // pointer to the bit array

int arraySize;

};

#endif

COP3330 Object Oriented Programming in C/C++

COP3330 Page 7

Appendix B: Main6.cpp

#include <iostream

using namespace std;

#include "sieve.h"

#include "bitarray.h"

int main()

{

unsigned int i, max, counter = 0;

cout << "\nEnter a positive integer for the maximum value: ";

cin max;

BitArray ba(max);

Sieve(ba); // find the primes (marking the bits)

cout << "The bit array looks like this: \n"

<< ba

<< '\n';

cout << "\nPrimes less than " << max << ':'<< '\n';

for (i = 0; i< max; i++)

{

if (ba.Query(i))

{

counter++;

cout << i;

if (counter % 8 == 0)

{

cout << '\n';

counter = 0;

}

else

cout << '\t';

}

}

cout << "\nGoodbye!\n";

return 0;

}

Description:

You will implement a class called BitArray, which will simulate a list of bits of any size, which can be individually set, cleared, flipped, and queried. You will also implement a function that is to be used by a sample test program, which uses the Sieve of Eratosthenes technique (with the bit array) to find prime numbers.

Details

Download these starter files:

bitarray.h -- Seen in Attachment A

main6.cpp -- a sample program for finding prime numbers

The BitArray class

Implement the BitArray class, defining all specified public member functions, in the file bitarray.cpp. Here are some details about the BitArray class:

1. A bit array is to be implemented with an underlying array of type unsigned char. 'Unsigned' because we are only interested in bits, not in negatives, and type char because it is the smallest integer type. The concept of a BitArray object is that it will store an array of bits (in the smallest storage space needed), indexed starting at 0, just like with normal arrays.

2. The array of characters should be created dynamically. The primary constructor has one parameter, which indicates how many bits are needed. The constructor should allocate the minimum number of cells needed for this many bits. Also, have the constructor initialize all bits to 0. Example:

3.

4. BitArray xy(35); // builds storage for at least 35 bits

5. // if we assume 1 byte char, this takes 5

6. // characters, for a total of 40 bits

7. The Length() function should return the total number of bits in the allocated array. In the example above (assuming 1 byte char), this is 40

8. While type char is commonly 8 bits on most machines today, you may not assume that this is always the case. Structure your class so that it is versatile enough to handle different platforms (where type char might differ in size). But always use the minimum number of char elements when creating the array. Hint: sizeof() is a function call that returns the exact number of bytes taken by a variable or type on a given machine:

COP3330 Object Oriented Programming in C/C++

COP3330 Page 2

9. int size = sizeof(int); // tells how many bytes for an int

10. // on current machine

Suggestion: Use a constant to store the size of an unsigned char in the program, for modifiable computations later. If using only inside the class, a static const is best.

11. Because dynamic allocation is used, the BitArray class should implement an appropriate destructor, copy constructor, and assignment operator (for deep copy and appropriate cleanup)

12. The functions Set(), Unset(), Flip(), and Query() represent the different things that can be done with one bit. Each function takes in an index number -- the index of the bit in question.

o Set() should set that bit to 1, without affecting any others

o Unset() should set that bit to 0, without affecting any others

o Flip() should change that bit to its opposite, without affecting any others

o Query() should return true if that bit is currently 1, and it should return false if that bit is currently 0

13. The operator overloads:

o operator<< -- the insertion operator should be written to do output of a BitArray object. Format is the entire array, printed as one continuous sequence of bits, inside parintheses. See example outputs from test program

o operator== and operator!= -- usual inequality operators. Entire arrays must match for them to be equal

14. General:

o You may add private functions to the class if you like, and you may add private constants. You may not change the public interface or the underlying storage (dynamic array of unsigned char).

o Note that NOT ALL features of the BitArray class are tested in the provided main7.cpp sample program. It is up to you to test all BitArray features.

Sieve of Eratosthenes

A common algorithm to find prime numbers is the Sieve of Eratosthenes. A description of algorithm can be found at the following link: (http://en.wikipedia.org/wiki/Sieve_of_Eratosthenes ) The main6.cpp program provided already sets up a BitArray object of desired size. Then it calls upon a function named Sieve.

Write the Sieve() function in a file called sieve.h. Do not change main6.cpp in any way. The Sieve() function should follow the Sieve of Eratosthenes pattern. The general algorithm is as follows:

1. Start by initializing all bits in the array to 1.

2. Each index of the bit array will represent one non-negative integer. Your algorithm should mark all non-prime numbers by setting these bits back to 0, proceeding as follows:

o 0 and 1 are never prime. Unset these bits to 0

o The next "uncleared" bit is prime. Leave this bit as a 1, but change all multiples of this value (not counting itself) to 0

o Move to the next "uncleared" bit and repeat

o This process only needs to repeat up to the square root of the array's length. (Example: If we are checking for the prime numbers from 0 through 500, then we can stop when we've reached sqrt(500), which is 22.36. Once we've reached an "uncleared" bit that is 23 or more, we know we've cleared all the non-primes

3. The remaining bits (which are still 1) indicate the primes.

COP3330 Object Oriented Programming in C/C++

COP3330 Page 3

You can find the sqrt() (square root) function in the library <cmath.

Submitting

Submit the files:

bitarray.h

bitarray.cpp

sieve.h

Grading Criteria:

The program compiles. If the program does not compile no further grading can be accomplished. Programs that do not compile will receive a zero.

(25 Points) The program executes without exception and produces output. The grading of the output cannot be accomplished unless the program executes.

(25 Points) The program produces the correct output.

(25 Points) The program specifications are followed.

(10 Points)The program is documented (commented) properly.

(5 Points)Use constants when values are not to be changed

(5 Points)Use proper indentation

(5 Points)Use good naming standards

COP3330 Object Oriented Programming in C/C++

COP3330 Page 4

Sample Runs

These are sample runs of the main6.cpp program, the Sieve program to find primes. Remember to write your own driver(s) to test other functions in class BitArray (such as comparison operators, copy constructor, etc).

Note that in the sample runs, the bit array really is printing on one line -- but it will probably show on screen wrapped around to multiple lines.

Sample run 1

Enter a positive integer for the maximum value: 345

The bit array looks like this:

(0011010100010100010100010000010100000100010100010000010000010100000100010100000

10001000001000000010001010001010001000000000000010001000001010000000001010000010

00001000100000100000101000000000101000101000000000001000000000001000101000100000

10100000000010000010000010000010100000100010100000000010000000000000100010100010

000000000000100000100000000010100)

Primes less than 345:

2 3 5 7 11 13 17 19

23 29 31 37 41 43 47 53

59 61 67 71 73 79 83 89

97 101 103 107 109 113 127 131

137 139 149 151 157 163 167 173

179 181 191 193 197 199 211 223

227 229 233 239 241 251 257 263

269 271 277 281 283 293 307 311

313 317 331 337

Goodbye!

Sample run 2

Enter a positive integer for the maximum value: 800

The bit array looks like this:

(0011010100010100010100010000010100000100010100010000010000010100000100010100000

10001000001000000010001010001010001000000000000010001000001010000000001010000010

00001000100000100000101000000000101000101000000000001000000000001000101000100000

10100000000010000010000010000010100000100010100000000010000000000000100010100010

00000000000010000010000000001010001000001000000010000010000010001000001000000010

00100000001000000000101000000000101000001000100000100000001000101000100000000000

10000000100010000000100010000010000000000010100000000000000000100000100000000010

00001000001010000010000000001000001000001010000010000010001010000000000010000000

00101000100000100000101000000000001000100000100000001000000000100000001000000000

10000000100000100000100010000000100000100010000000100010000000000000100000000010

0)

COP3330 Object Oriented Programming in C/C++

COP3330 Page 5

Primes less than 800:

2 3 5 7 11 13 17 19

23 29 31 37 41 43 47 53

59 61 67 71 73 79 83 89

97 101 103 107 109 113 127 131

137 139 149 151 157 163 167 173

179 181 191 193 197 199 211 223

227 229 233 239 241 251 257 263

269 271 277 281 283 293 307 311

313 317 331 337 347 349 353 359

367 373 379 383 389 397 401 409

419 421 431 433 439 443 449 457

461 463 467 479 487 491 499 503

509 521 523 541 547 557 563 569

571 577 587 593 599 601 607 613

617 619 631 641 643 647 653 659

661 673 677 683 691 701 709 719

727 733 739 743 751 757 761 769

773 787 797

Goodbye!

COP3330 Object Oriented Programming in C/C++

COP3330 Page 6

Appendix A: bitarray.h

// bitarray.h

//

// BitArray class declaration

#ifndef _BITARRAY_H

#define _BITARRAY_H

#include <iostream

using namespace std;

class BitArray

{

friend ostream& operator<< (ostream& os, const BitArray& a);

friend bool operator== (const BitArray&, const BitArray&);

friend bool operator!= (const BitArray&, const BitArray&);

public:

BitArray(unsigned int n); // Construct an array that can handle n bits

BitArray(const BitArray&); // copy constructor

~BitArray(); // destructor

BitArray& operator= (const BitArray& a); // assignment operator

unsigned int Length() const; // return number of bits in bitarray

void Set (unsigned int index); // set bit with given index to 1

void Unset (unsigned int index); // set bit with given index to 0

void Flip (unsigned int index); // change bit (with given index)

bool Query (unsigned int index) const; // return true if the given bit

// is set to 1, false otherwise

private:

unsigned char* barray; // pointer to the bit array

int arraySize;

};

#endif

COP3330 Object Oriented Programming in C/C++

COP3330 Page 7

Appendix B: Main6.cpp

#include <iostream

using namespace std;

#include "sieve.h"

#include "bitarray.h"

int main()

{

unsigned int i, max, counter = 0;

cout << "\nEnter a positive integer for the maximum value: ";

cin max;

BitArray ba(max);

Sieve(ba); // find the primes (marking the bits)

cout << "The bit array looks like this: \n"

<< ba

<< '\n';

cout << "\nPrimes less than " << max << ':'<< '\n';

for (i = 0; i< max; i++)

{

if (ba.Query(i))

{

counter++;

cout << i;

if (counter % 8 == 0)

{

cout << '\n';

counter = 0;

}

else

cout << '\t';

}

}

cout << "\nGoodbye!\n";

return 0;

}

You'll get a 964.0KB .ZIP file.