"""

-------------------------------------------------------
[program description]
-------------------------------------------------------
Author: Malaz Ismail
ID: 190894950
Email: [email protected]
__updated__ = "2020-02-27"
-------------------------------------------------------
"""
from copy import deepcopy

class List:

def __init__(self):
"""
-------------------------------------------------------
Initializes an empty list.
Use: target = List()
-------------------------------------------------------
Returns:
a new List object (List)
-------------------------------------------------------
"""
self._values = []

def __getitem__(self, i):

"""
-------------------------------------------------------
Returns a copy of the nth element of the list.
Use: value = source[i]
-------------------------------------------------------
Parameters:
i - index of the element to access (int)
Returns:
value - the i-th element of list (?)
-------------------------------------------------------
"""
assert self._is_valid_index(i), 'Invalid index value'

value = deepcopy(self._values[i])

return value

def __len__(self):
"""
-------------------------------------------------------
Returns the number of values in the list.
Use: n = len(source)
-------------------------------------------------------
Returns:
the number of values in the list.
-------------------------------------------------------
"""
return len(self._values)

def __setitem__(self, i, value):

"""
 -------------------------------------------------------
The i-th element of list contains a copy of value. The existing
value at i is overwritten.
Use: source[i] = value
-------------------------------------------------------
Parameters:
i - index of the element to access (int)
value - a data value (?)
Returns:
None
-------------------------------------------------------
"""
assert self._is_valid_index(i), 'Invalid index value'

self._values[i] = deepcopy(value)

return

def __contains__(self, key):

"""
---------------------------------------------------------
Determines if the list contains key.
Use: b = key in source
-------------------------------------------------------
Parameters:
key - a partial data element (?)
Returns:
True if the list contains key, False otherwise. (boolean)
-------------------------------------------------------
"""
isin = False

if key in self._values:
isin = True
i = self._linear_search(key)

return isin

def _is_valid_index(self, i):

"""
-------------------------------------------------------
Private helper method to validate an index value.
Python index values can be positive or negative and range from
-len(list) to len(list) - 1
Use: assert self._is_valid_index(i)
-------------------------------------------------------
Parameters:
i - an index value (int)
Returns:
True if i is a valid index, False otherwise.
-------------------------------------------------------
"""
validindex = False
if i > (-len(self._values)) or i < len(self._values) or i == 0:
validindex = True

return validindex

def _linear_search(self, key):

 """
-------------------------------------------------------
Searches for the first occurrence of key in the list.
Private helper method - used only by other ADT methods.
Use: i = self._linear_search(key)
-------------------------------------------------------
Parameters:
key - a partial data element (?)
Returns:
i - the index of key in the list, -1 if key is not found (int)
-------------------------------------------------------
"""
index = -1
for i in range(len(self._values)):
if self._values[i] == key:
index = i
return index

def _swap(self, i, j):

"""
-------------------------------------------------------
Swaps the position of two elements in the data list.
The element originally at position i is now at position j,
and visa versa.
Private helper operations called only from within class.
Use: self._swap(i, j)
-------------------------------------------------------
Parameters:
i - index of one element to switch (int, 0 <= i < len(self._values))
j - index of other element to switch (int, 0 <= j < len(self._values))
Returns:
None
-------------------------------------------------------
"""
assert self._is_valid_index(i), 'Invalid index i'
assert self._is_valid_index(j), 'Invalid index j'

temp = self._values[i]
self._values[i] = self._values[j]
self._values[j] = temp

return

def append(self, value):

"""
-------------------------------------------------------
Adds a copy of value to the end of the List.
Use: source.append(value)
-------------------------------------------------------
Parameters:
value - a data element (?)
Returns:
None
-------------------------------------------------------
"""
self._values.append(value)

return
def apply(self, func):
"""
-------------------------------------------------------
Applies an external function to every value in list.
Use: source.apply(func)
-------------------------------------------------------
Parameters:
func - a function that takes a single value as a parameter
and returns a value (function)
Returns:
None
-------------------------------------------------------
"""
for i in range (len(self._values)):
self._values[i] = func(self._values[i])

return

def clean(self):
"""
---------------------------------------------------------
The list contains one and only one of each value formerly present
in the list. The first occurrence of each value is preserved.
Use: source.clean()
-------------------------------------------------------
Returns:
None
-------------------------------------------------------
"""
i = 0
while i < len(self._values):
index = i+1
while index < len(self._values):
if self._values[index] == self._values[i]:
self._values = self._values[0:index] + self._values[index+1::]
else:
index += 1
i += 1

return

def combine(self, source1, source2):

"""
-------------------------------------------------------
Combines two source lists into the current target list.
When finished, the contents of source1 and source2 are interlaced
into target and source1 and source2 are empty.
Order of source values is preserved.
Use: target.combine(source1, source2)
-------------------------------------------------------
Parameters:
source1 - an array-based list (List)
source2 - an array-based list (List)
Returns:
None
-------------------------------------------------------
"""
switch = True
 while len(source1._values) != 0 or len(source2._values) != 0:
if len(source2._values) == 0:
self._values += [source1._values[0]]
if len(source1._values) == 1:
source1._values = []
else:
source1._values = source1._values[1:len(source1._values)]

elif len(source1._values) == 0:
self._values += [source2._values[0]]
if len(source2._values) == 1:
source2._values = []
else:
source2._values = source2._values[1:len(source2._values)]

elif switch:
self._values += [source1._values[0]]
source1._values = source1._values[1:len(source1._values)]

else:
self._values += [source2._values[0]]
source2._values = source2._values[1:len(source2._values)]

switch = not switch

return

def copy(self):
"""
-------------------------------------------------------
Duplicates the current list to a new list in the same order.
Use: target = source.copy()
-------------------------------------------------------
Returns:
target - a copy of self (List)
-------------------------------------------------------
"""
target = List()
target._values = self._values

return target

def count(self, key):

"""
-------------------------------------------------------
Finds the number of times key appears in list.
Use: n = source.count(key)
-------------------------------------------------------
Parameters:
key - a partial data element (?)
Returns:
number - number of times key appears in list (int)
-------------------------------------------------------
"""
count = 0

for i in self._values:
 if key == i:
count+=1

return count

def find(self, key):

"""
-------------------------------------------------------
Finds and returns a copy of the first value in list that matches key.
Use: value = source.find(key)
-------------------------------------------------------
Parameters:
key - a partial data element (?)
Returns:
value - a copy of the full value matching key, otherwise None (?)
-------------------------------------------------------
"""
index = self._linear_search(key)
if index != -1:
value = self._values[index]
else:
value = None
return value

def index(self, key):

"""
-------------------------------------------------------
Finds location of a value by key in list.
Use: n = source.index(key)
-------------------------------------------------------
Parameters:
key - a partial data element (?)
Returns:
i - the index of the location of key in the list, -1 if
key is not in the list. (int)
-------------------------------------------------------
"""
index1 = self._linear_search(key)

return index1

def insert(self, index, value):

"""
-------------------------------------------------------
A copy of value is added to index i, following values are pushed right.
If i outside of range of -len(list) to len(list) - 1, the value is
prepended or appended as appropriate.
Use: source.insert(i, value)
-------------------------------------------------------
Parameters:
i - index value (int)
value - a data element (?)
Returns:
None
-------------------------------------------------------
"""
self._values[:] = self._values[:index] + [deepcopy(value)] +
self._values[index:]
return None
def intersection(self, source1, source2):
"""
-------------------------------------------------------
Update the current list with values that appear in both
source1 and source2. Values do not repeat.
Use: target.intersection(source1, source2)
-------------------------------------------------------
Parameters:
source1 - an array-based list (List)
source2 - an array-based list (List)
Returns:
None
-------------------------------------------------------
"""
for i in source1:
if i in source2 and i not in self._values:
self._values += [i]

return

def is_empty(self):
"""
-------------------------------------------------------
Determines if the list is empty.
Use: b = source.is_empty()
-------------------------------------------------------
Returns:
True if the list is empty, False otherwise.
-------------------------------------------------------
"""
is_empty = False
if len(self._values) == 0:
is_empty = True

return is_empty

def is_identical(self, target):

"""
---------------------------------------------------------
Determines whether two lists are is_identical, i.e. same values
appear in the same locations in both lists.
(iterative version)
Use: b = source.is_identical(target)
-------------------------------------------------------
Parameters:
target - another list (List)
Returns:
identical - True if this list contains the same values
as target in the same order, otherwise False. (boolean)
-------------------------------------------------------
"""
if len(self._values) != len(target._values):
identical = False
else:
identical = True
i = 0
while identical and i < len(self._values):
 if self._values[i] != target._values[i]:
identical = False
i += 1

return identical
def max(self):
"""
-------------------------------------------------------
Finds the maximum value in list.
Use: value = source.max()
-------------------------------------------------------
Returns:
value - a copy of the maximum value in the list (?)
-------------------------------------------------------
"""
assert (len(self._values) > 0), 'Cannot find maximum of an empty list'

maxi = deepcopy(self._values[0])
for i in self._values:
if i > maxi:
maxi = i
return maxi

return

def min(self):
"""
-------------------------------------------------------
Finds the minimum value in list.
Use: value = source.min()
-------------------------------------------------------
Returns:
value - a copy of the minimum value in the list (?)
-------------------------------------------------------
"""
assert (len(self._values) > 0), 'Cannot find minimum of an empty list'

mini = deepcopy(self._values[0])
for i in self._values:
if i < mini:
mini = i

return mini

def peek(self):
"""
-------------------------------------------------------
Returns a copy of the first value in list.
Use: value = source.peek()
-------------------------------------------------------
Returns:
value - a copy of the first value in the list (?)
-------------------------------------------------------
"""
assert (len(self._values) > 0), 'Cannot peek at an empty list'

value = deepcopy(self._values[0])
 return value

def pop(self, *args):

"""
-------------------------------------------------------
Finds, removes, and returns the value in list whose index matches i.
Use: value = source.pop()
Use: value = source.pop(i)
-------------------------------------------------------
Parameters:
args - an array of arguments (tuple of int)
args[0], if it exists, is the index i
Returns:
value - if args exists, the value at position args[0],
otherwise the last value in the list, value is
removed from the list (?)
-------------------------------------------------------
"""
assert len(self._values) > 0, "Cannot pop from an empty list"
assert len(args) <= 1, "No more than 1 argument allowed"

if len(args) == 1:
# pop the element at position i
i = args[0]
value = self._values.pop(i)
else:
# pop the last element
value = self._values.pop()
return value

def prepend(self, value):

"""
-------------------------------------------------------
Adds a copy of value to the front of the List.
Use: source.prepend(value)
-------------------------------------------------------
Parameters:
value - a data element. (?)
Returns:
None
-------------------------------------------------------
"""
self._values = [deepcopy(value)] + self._values

return

def remove(self, key):

"""
-------------------------------------------------------
Finds, removes, and returns the first value in list that matches key.
Use: value = source.remove(key)
-------------------------------------------------------
Parameters:
key - a partial data element (?)
Returns:
value - the full value matching key, otherwise None (?)
-------------------------------------------------------
"""
assert len(self._values) > 0, "Cannot remove from an empty list"
 i = self._linear_search(key)
if i == -1:
values = None
else:
values = self._values.pop(i)
return values

def remove_front(self):
"""
-------------------------------------------------------
Removes the first node in the list.
Use: value = source.remove_front()
-------------------------------------------------------
Returns:
value - the first value in the list (?)
-------------------------------------------------------
"""
assert (len(self._values) > 0), 'Cannot remove from an empty list'

assert (len(self._values) > 0), 'Cannot remove from an empty list'

value = deepcopy(self._values[0])
self._values = self._values[1:len(self._values)]

return value

def remove_many(self, key):

"""
-------------------------------------------------------
Finds and removes all values in the list that match key.
Use: source.remove_many(key)
-------------------------------------------------------
Parameters:
key - a data element (?)
Returns:
None
-------------------------------------------------------
"""
i = self._linear_search(key)
while i != -1:
self._values = self._values[0:i] + self._values[i+1:len(self._values)]
i = self._linear_search(key)

return

def reverse(self):
"""
-------------------------------------------------------
The contents of list are reversed in order with respect
to their order before the operation was called.
Use: source.reverse()
-------------------------------------------------------
Returns:
None
-------------------------------------------------------
"""
self._values = self._values[::-1]
return
def split(self):
"""
-------------------------------------------------------
Splits list into two parts. target1 contains the first half,
target2 the second half. Current list becomes empty.
Use: target1, target2 = source.split()
-------------------------------------------------------
Returns:
target1 - a new List with >= 50% of the original List (List)
target2 - a new List with <= 50% of the original List (List)
-------------------------------------------------------
"""
target1 = List()
target2 = List()

if len(self._values) % 2 == 0:
mid = len(self._values)//2
else:
mid = len(self._values)//2 + 1

target1._values = self._values[0:mid]
target2._values = self._values[mid:len(self._values)]
self._values = []

return target1, target2

def split_alt(self):
"""
-------------------------------------------------------
Splits the source list into separate target lists with values
alternating into the targets. At finish source list is empty.
Order of source values is preserved.
Use: target1, target2 = source.split()
-------------------------------------------------------
Returns:
target1 - contains alternating values from source (List)
target2 - contains other alternating values from source (List)
-------------------------------------------------------
"""
target1 = List()
target2 = List()
left = True

while len(self._values) != 0:
if left:
target1._values += [self._values[0]]
self._values = self._values[1:len(self._values)]
else:
target2._values += [self._values[0]]
self._values = self._values[1:len(self._values)]

left = not left

return target1, target2

def split_apply(self, func):

 """
-------------------------------------------------------
Splits list into two parts. target1 contains all the values
where the result of calling func(value) is True, target2 contains
the remaining values. At finish, self is empty. Order of values
in targets is maintained.
Use: target1, target2 = source.split_apply(func)
-------------------------------------------------------
Parameters:
func - a function that given a value in the list returns
True for some condition, otherwise returns False.
Returns:
target1 - a new List with values where func(value) is True (List)
target2 - a new List with values where func(value) is False (List)
-------------------------------------------------------
"""
target1 = List()
target2 = List()

while len(self._values) != 0:
if func(self._values[0]):
target1._values += [self._values[0]]
else:
target2._values += [self._values[0]]

if len(self._values) == 1:
self._values = []
else:
self._values = self._values[1:len(self._values)]

return target1, target2

def split_key(self, key):

"""
-------------------------------------------------------
Splits list so that target1 contains all values < key,
and target2 contains all values >= key.
Use: target1, target2 = source.split_key()
-------------------------------------------------------
Returns:
target1 - a new List of values < key (List)
target2 - a new List of values >= key (List)
-------------------------------------------------------
"""
target1 = List()
target2 = List()

while len(self._values) != 0:
if self._values[0] < key:
target1._values += [self._values[0]]
else:
target2._values += [self._values[0]]

if len(self._values) == 1:
self._values = []
else:
self._values = self._values[1:len(self._values)]

return target1, target2

def __str__(self):
strg = '['
for value in self._values:
value = str(value)
strg+= value + ","
strg+= "]"
return strg

def union(self, source1, source2):

"""
-------------------------------------------------------
Update the current list with all values that appear in
source1 and source2. Values do not repeat.
Use: target.union(source1, source2)
-------------------------------------------------------
Parameters:
source1 - an array-based list (List)
source2 - an array-based list (List)
Returns:
None
-------------------------------------------------------
"""
for i in source1._values:
if i not in self._values:
self._values += [i]

for i in source2._values:
if i not in self._values:
self._values += [i]

return

def __iter__(self):
"""
USE FOR TESTING ONLY
-------------------------------------------------------
Generates a Python iterator. Iterates through the list
from front to rear.
Use: for v in source:
-------------------------------------------------------
Returns:
value - the next value in the list (?)
-------------------------------------------------------
"""
for value in self._values:
yield value