Add information about memory profiling for Python programs.

Author: eda-ricercatore

circuit-simulation/normal-in-memory-comp/logic-gates/.DS_Store

@@ -826,6 +826,7 @@ Submission: Feb 12, 2020, anywhere on Earth
 
 
 
+
 + finish automated regression for the *data analysis tool*:
 	- data_analysis_tool.py
 		* get_percent_error(experimental_value=1,theoretical_value=1).
@@ -840,6 +841,9 @@ Submission: Feb 12, 2020, anywhere on Earth
 
 
 + perform ***performance sensitivity analysis and the optimization***
++ [ ] memory profiling of *Python* programs
+  - https://code.tutsplus.com/tutorials/understand-how-much-memory-your-python-objects-use--cms-25609
+
 
 
 Need 27 classroom hours; I have 15 + 4 + 9 = 28 hours.

notes/report/scratch-pad.md

@@ -19,6 +19,14 @@
 
 	Revision History:
 	September 6, 2019			Version 0.1	Script.
+	
+	References:
+	+ \cite[From section 'Built-in Functions']{DrakeJr2016b}.
+		- Available online from Python: Python 3.8.2rc1
+			documentation: The Python Standard Library:
+			 Built-in Functions at: https://docs.python.org/3/library/functions.html#bin;
+			 February 12, 2020 was the last accessed date.
+	+ \cite{KiteStaff2020}
 """
 
 __author__ = 'Zhiyang Ong'
@@ -220,9 +228,10 @@ def gen_rand_signal_uniform_distributn(type_of_signal=bv_signal, n=16):
 			"""
 		return random_signal
 	# ============================================================
-	##	Method to generate a discrete-time random signal/process
-	#		for "n" values, using another method from the random
-	#		module of the Python Standard Library.
+	##	Method to generate a bit vector -based discrete-time
+	#		random signal/process for "n" values, using another
+	#		method from the random module of the Python Standard
+	#		Library.
 	#
 	#	Use the Python Standard Library's random module to call the
 	#		random.getrandbits(k) function that is based on the
@@ -233,13 +242,69 @@ def gen_rand_signal_uniform_distributn(type_of_signal=bv_signal, n=16):
 	#	- low value: "0"
 	#
 	#	@param n - number of discrete values used to represent the
-	#				random signal/"process".
-	#				Its default value is: 16.
+	#		random bit vector signal/"process".
+	#		Its default value is: 16.
 	#	@return - Nothing.
 	#	O(1) method.
+	#
+	#	Reference:
+	#	+ [KiteStaff2020]
+	#		- Kite staff, "getrandbits", from Kite: The Python Language:
+	#		Kite Docs: random, Kite, San Francisco, CA, no date.
+	#		Available online from Kite: The Python Language:
+	#			Kite Docs: random at: https://kite.com/python/docs/random.getrandbits;
+	#			February 12, 2020 was the last accessed date.
+	#
+	#	Additional resources:
+	#	+ https://pythonhosted.org/bitstring/bitarray.html
+	#	+ https://wiki.python.org/moin/BitArrays
+	
 	@staticmethod
 	def gen_bit_vector_getrandbits(n=16):
-		return random.getrandbits(n)
+		# Empty list representation of a random bit vector/signal.
+		list_of_int_representation_of_bv = []
+		"""
+			Since the method call random.getrandbits(n) generates
+				an integer representation of a bit-vector, the
+				bin() method is needed to map/transform the
+				integer-representation of a bit-vector into a
+				binary string representation.
+
+			Add one to the input argument of random.getrandbits(),
+				since it would only generate (n-1) values/digits
+				otherwise.
+
+			References for using bin() to convert integers
+				into a binary string.
+			+ \cite[From section 'Built-in Functions']{DrakeJr2016b}.
+				- Available online from Python: Python 3.8.2rc1
+					documentation: The Python Standard Library:
+					 Built-in Functions at: https://docs.python.org/3/library/functions.html#bin;
+					 February 12, 2020 was the last accessed date.
+			+ \cite{KiteStaff2020}
+		"""
+		#bin_representation_of_bv = bin(random.getrandbits(n+1))
+		bin_representation_of_bv = bin(random.getrandbits(n))
+		print("!!!	bin_representation_of_bv is:",bin_representation_of_bv,".")
+		print("!!!	bin_representation_of_bv[2:] is:",bin_representation_of_bv[2:],".")
+		"""
+			Map/transform the integer-representation of a
+				bit-vector into a binary string representation.
+		"""
+		list_representation_of_bv = list(bin_representation_of_bv[2:])
+		"""
+			For each value/digit/bit in the random bit vector
+				signal/"process",
+		"""
+		#for value_in_bv in list_representation_of_bv:
+		for index_in_bv in range(len(list_representation_of_bv)):
+			"""
+				Cast it into an integer and add it to the
+					list representation of the random integer
+					bits.
+			"""
+			list_of_int_representation_of_bv.append(int(list_representation_of_bv[index_in_bv]))
+		return list_of_int_representation_of_bv
 
 
 

source/random_process_models/random_process_generator.py

@@ -145,12 +145,23 @@ def test_gen_rand_signal_uniform_distributn():
 	#	O(1) method.
 	@staticmethod
 	def test_gen_bit_vector_getrandbits():
+		print("	Testing gen_bit_vector_getrandbits().")
+		prompt = "	... Test random bit vector generation: default 16 bits.	{}"
 		# Number of discrete values representing a random signal/"process".
+		k = 16
+		statistical_analysis.increment_number_test_cases_used()
+		temp_rand_signal = rand_signal_generator.gen_bit_vector_getrandbits()
+		#print("!!!	temp_rand_signal is:",temp_rand_signal,".")
+		if (k == len(temp_rand_signal)) and ((0 in temp_rand_signal) or (1 in temp_rand_signal)) and (not (-1 in temp_rand_signal)) and (not (3.14 in temp_rand_signal)):
+			print(prompt .format("OK"))
+			statistical_analysis.increment_number_test_cases_passed()
+		else:
+			print(prompt .format("FAIL!!!"))
+		prompt = "	... Test random bit vector generation: 8 bits.		{}"
 		k = 8
-		print("	Testing gen_rand_signal_uniform_distributn().")
-		prompt = "	... Test: type of signal = bit vector.			{}"
 		statistical_analysis.increment_number_test_cases_used()
 		temp_rand_signal = rand_signal_generator.gen_bit_vector_getrandbits(k)
+		#print("!!!	temp_rand_signal is:",temp_rand_signal,".")
 		if (k == len(temp_rand_signal)) and ((0 in temp_rand_signal) or (1 in temp_rand_signal)) and (not (-1 in temp_rand_signal)) and (not (3.14 in temp_rand_signal)):
 			print(prompt .format("OK"))
 			statistical_analysis.increment_number_test_cases_passed()