-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathNPack.XML
More file actions
4730 lines (4726 loc) · 230 KB
/
NPack.XML
File metadata and controls
4730 lines (4726 loc) · 230 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>NPack</name>
</assembly>
<members>
<member name="T:NPack.SingleComponent">
<summary>
A matrix component value modeled by a single-precision floating point.
</summary>
<remarks>
Use this structure as the type parameter for <see cref="!:Matrix<T>"/> when you want
a matrix of single values, since it implements <see cref="T:NPack.Interfaces.IComputable`1"/>, which
allows numerical operations on value types.
</remarks>
</member>
<member name="T:NPack.Interfaces.IComputable`1">
<summary>
Defines a type which has typical numerically computable properties.
</summary>
<typeparam name="T">Type which is computable.</typeparam>
</member>
<member name="T:NPack.Interfaces.IArithmetic`1">
<summary>
Every class that defines the standard arithmetic operations +, -, *, / should
consider implementing this interface. This interface does not contain
<see cref="T:NPack.Interfaces.IInvertible`1"/> because some arithmetic types such as
<see cref="T:System.Int32"/>, <see cref="T:System.Int64"/>,
etc., do not have an inverse as defined in IInvertible.
</summary>
<typeparam name="T">Type which has aritmetic operations defined on.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="T:NPack.Interfaces.INegatable`1">
<summary>
Every class that defines a unary - operation
such that <c>x + (-x) = e</c> and <c>-(-x) = x</c> should consider
implementing this interface.
</summary>
<typeparam name="T">Type which is negatable.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="T:NPack.Interfaces.ISubtractable`1">
<summary>
Every class that defines a - operation
like <c>T operator - (T a, T b)</c> should consider
implementing this interface.
</summary>
<typeparam name="T">Type which is subtractable.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="M:NPack.Interfaces.ISubtractable`1.Subtract(`0)">
<summary>
Returns the difference of the Object and <paramref name="b"/>.
It must not modify the value of the Object.
</summary>
<param name="b">The second operand.</param>
<returns>The difference.</returns>
</member>
<member name="T:NPack.Interfaces.IHasZero`1">
<summary>
Every class that has a + operation and an element
such that <code>x + e = e + x = x</code> for all x should consider implementing this
interface. If T is a <see cref="T:System.ValueType"/>, e should be the default value.
</summary>
<typeparam name="T">Type which has zero defined.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="T:NPack.Interfaces.IAddable`1">
<summary>
Every class that defines a + operation
like <c>T operator + (T a, T b)</c> should consider
implementing this interface.
</summary>
<typeparam name="T">Type which is addable.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="M:NPack.Interfaces.IAddable`1.Add(`0)">
<summary>
Returns the sum of the Object and <paramref name="b"/>.
It must not modify the value of the Object.
</summary>
<param name="b">The second operand.</param>
<returns>The sum.</returns>
</member>
<member name="P:NPack.Interfaces.IHasZero`1.Zero">
<summary>
Returns the additive identity.
</summary>
<value>e</value>
</member>
<member name="M:NPack.Interfaces.INegatable`1.Negative">
<summary>
Returns the negative of the Object. Must not modify the Object itself.
</summary>
<returns>The negative.</returns>
</member>
<member name="T:NPack.Interfaces.IDivisible`1">
<summary>
Every class that defines a / operation
like <c>T operator / (T a, T b)</c> should consider
implementing this interface.
</summary>
<typeparam name="T">Type which is divisible.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="M:NPack.Interfaces.IDivisible`1.Divide(`0)">
<summary>
Returns the quotient of the Object and <paramref name="b"/>.
It must not modify the value of the Object.
</summary>
<param name="b">The second operand.</param>
<returns>The quotient.</returns>
</member>
<member name="T:NPack.Interfaces.IHasOne`1">
<summary>
Every class that has a * operation and an element
such that <code>x * e = e * x = x</code> for all x should consider implementing
this interface.
</summary>
<typeparam name="T">Type which has multiplicative identity defined.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="T:NPack.Interfaces.IMultipliable`1">
<summary>
Every class that defines a * operation
like <c>T operator * (T a,T b)</c> should consider
implementing this interface.
</summary>
<typeparam name="T">Type which is multipliable.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="M:NPack.Interfaces.IMultipliable`1.Multiply(`0)">
<summary>
Returns the product of the Object and <paramref name="b"/>.
It must not modify the value of the Object.
</summary>
<param name="b">The second operand.</param>
<returns>The product.</returns>
</member>
<member name="P:NPack.Interfaces.IHasOne`1.One">
<summary>
Returns the multiplicative identity.
</summary>
<value>e</value>
</member>
<member name="T:NPack.Interfaces.IBooleanComparable`1">
<summary>
Defines a type which can be compared with boolean comparison operations: >, >=, <, or <=.
</summary>
<typeparam name="T">Type on which boolean comparison is defined.</typeparam>
</member>
<member name="M:NPack.Interfaces.IBooleanComparable`1.GreaterThan(`0)">
<summary>
Returns true if the value called on is strictly greater than the <paramref name="value"/> given.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the called on instance is greater, false if the <paramref name="value"/> is greater or equal.</returns>
</member>
<member name="M:NPack.Interfaces.IBooleanComparable`1.GreaterThanOrEqualTo(`0)">
<summary>
Returns true if the value called on is greater than or equal to the <paramref name="value"/> given.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the called on instance is greater or equal, false if the <paramref name="value"/> is greater.</returns>
</member>
<member name="M:NPack.Interfaces.IBooleanComparable`1.LessThan(`0)">
<summary>
Returns true if the value called on is strictly less than the <paramref name="value"/> given.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the called on instance is less, false if the <paramref name="value"/> is less or equal.</returns>
</member>
<member name="M:NPack.Interfaces.IBooleanComparable`1.LessThanOrEqualTo(`0)">
<summary>
Returns true if the value called on is less than or equal to the <paramref name="value"/> given.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the called on instance is less or equal, false if the <paramref name="value"/> is less.</returns>
</member>
<member name="T:NPack.Interfaces.IExponential`1">
<summary>
Defines a type which can be operated on by exponential operations.
</summary>
<typeparam name="T">Type on which exponentiation is defined.</typeparam>
</member>
<member name="M:NPack.Interfaces.IExponential`1.Power(System.Double)">
<summary>
Returns a value which is the called on value raised to the given <paramref name="exponent"/>.
</summary>
<param name="exponent">The power to raise the value by.</param>
<value>x ^ <c>exponent</c></value>
<returns>The value called on raised to the power given.</returns>
</member>
<member name="M:NPack.Interfaces.IExponential`1.Sqrt">
<summary>
Returns a value which is the square root of the value called on.
</summary>
<value>x ^ 0.5</value>
<returns>The value called on raised to the power of 0.5.</returns>
</member>
<member name="M:NPack.Interfaces.IExponential`1.Log(System.Double)">
<summary>
Returns a value which is the natural log of the called-on value given the new base.
</summary>
<param name="newBase">New base to find what the called-on value is the exponent of.</param>
<value>ln <c>value</c> / ln <c>newBase</c></value>
<returns>The log</returns>
</member>
<member name="M:NPack.Interfaces.IExponential`1.Log">
<summary>
Returns a value which is the natural log of the called-on value.
</summary>
<value>ln <c>value</c></value>
<returns>The natural log of the given value.</returns>
</member>
<member name="M:NPack.Interfaces.IExponential`1.Exp">
<summary>
Returns <c>e</c> raised to the power of the called on value.
</summary>
<value>e ^ <c>value</c></value>
<returns>The value of the natural log base, e, raised to the power of the called on value.</returns>
</member>
<member name="M:NPack.Interfaces.IComputable`1.Abs">
<summary>
Computes the absolute value of the value.
</summary>
<returns>The absolute value of the IComputable value.</returns>
</member>
<member name="M:NPack.Interfaces.IComputable`1.Set(System.Double)">
<summary>
Sets the value of the IComputable value.
</summary>
<param name="value">Value used to set the IComputable.</param>
<returns>The value of the IComputable converted from <paramref name="value"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.#ctor(System.Single)">
<summary>
Creates a new SingleComponent initialized to the given
<paramref name="value"/>.
</summary>
<param name="value">
The value to set this SingleComponent to.
</param>
</member>
<member name="M:NPack.SingleComponent.ToString">
<summary>
Returns String representation of this value.
</summary>
<returns>A formatted String displaying this value.</returns>
</member>
<member name="M:NPack.SingleComponent.GetHashCode">
<summary>
Generates a hash code for the SingleComponent value.
</summary>
<returns>A value to represent this value in a hash table.</returns>
</member>
<member name="M:NPack.SingleComponent.op_Implicit(System.Single)~NPack.SingleComponent">
<summary>
Implicitly converts a Single value to a SingleComponent.
</summary>
<param name="value">Value to convert.</param>
<returns>
A SingleComponent set to <paramref name="value"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.op_Explicit(NPack.SingleComponent)~System.Single">
<summary>
Explicitly converts a SingleComponent to a Single.
</summary>
<param name="component">SingleComponent to convert.</param>
<returns>
Value of type Single with the same value as the SingleComponent.
</returns>
</member>
<member name="M:NPack.SingleComponent.op_Addition(NPack.SingleComponent,System.Single)">
<summary>
Adds a SingleComponent and a Single.
</summary>
<param name="lhs">Left hand of the addition operation.</param>
<param name="rhs">Right hand of the addition operation.</param>
<returns>
The sum of <paramref name="lhs"/> and <paramref name="rhs"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.op_Subtraction(NPack.SingleComponent,System.Single)">
<summary>
Subtracts a Single from a SingleComponent.
</summary>
<param name="lhs">Left hand of the subtraction operation.</param>
<param name="rhs">Right hand of the subtraction operation.</param>
<returns>
The difference of <paramref name="lhs"/> and <paramref name="rhs"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Equals(NPack.SingleComponent)">
<summary>
Evaluates equality of two SingleComponent instances.
</summary>
<param name="other">The SingleComponent to compare to.</param>
<returns>
True if the two SingleComponent instances are equal; false otherwise.
</returns>
</member>
<member name="M:NPack.SingleComponent.CompareTo(NPack.SingleComponent)">
<summary>
Compares two SingleComponent instances.
</summary>
<param name="other">The SingleComponent to compare to.</param>
<returns>
0 if they are equal,
1 if the called-on instance is greater,
-1 if <paramref name="other"/> is greater.
</returns>
</member>
<member name="M:NPack.SingleComponent.Add(NPack.SingleComponent)">
<summary>
Adds two SingleComponent values.
</summary>
<param name="a">The other addend.</param>
<returns>
The sum of this SingleComponent and <paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Subtract(NPack.SingleComponent)">
<summary>
Subtracts two SingleComponent values.
</summary>
<param name="a">The subtrahend.</param>
<returns>
The difference of this SingleComponent (minuend) and
<paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Negative">
<summary>
Returns the negation of the SingleComponent value. Also the
additive inverse.
</summary>
<remarks>
The value returns solves the following equation:
<code>
SingleComponent a = 5, b = a.Negative();
Assert.IsTrue(a.Add(b).Equals(0));
</code>
</remarks>
<returns>The negated SingleComponent.</returns>
</member>
<member name="M:NPack.SingleComponent.Multiply(NPack.SingleComponent)">
<summary>
Multiplies two SingleComponents and returns the product.
</summary>
<param name="a">The multiplier.</param>
<returns>
The product of the SingleComponent instance and
<paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Divide(NPack.SingleComponent)">
<summary>
Divides two SingleComponent instances and returns the quotient.
</summary>
<param name="a">The divisor.</param>
<returns>
The quotient of dividing the SingleComponent instance
(the dividend) and <paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Equals(System.Single)">
<summary>
Evaluates equality of a SingleComponent instance and a Single value.
</summary>
<param name="other">The Single value to compare to.</param>
<returns>
True if the two SingleComponent instances are equal; false otherwise.
</returns>
</member>
<member name="M:NPack.SingleComponent.CompareTo(System.Single)">
<summary>
Compares a SingleComponent instance and a Single value.
</summary>
<param name="other">The Single value to compare to.</param>
<returns>
0 if they are equal,
1 if the SingleComponent instance is greater,
-1 if <paramref name="other"/> is greater.
</returns>
</member>
<member name="M:NPack.SingleComponent.Add(System.Single)">
<summary>
Adds a SingleComponent value and a Single.
</summary>
<param name="a">The other addend.</param>
<returns>
The sum of this SingleComponent and <paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Subtract(System.Single)">
<summary>
Subtracts a Single value from the SingleComponent value.
</summary>
<param name="a">The subtrahend.</param>
<returns>
The difference of this SingleComponent (minuend) and
<paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#INegatable{System#Single}#Negative">
<summary>
Returns the negation of the SingleComponent value as a Single. Also the
additive inverse.
</summary>
<remarks>
The value returns solves the following equation:
<code>
SingleComponent a = 5, b = a.Negative();
Assert.IsTrue(a.Add(b).Equals(0));
</code>
</remarks>
<returns>The negated SingleComponent as a Single.</returns>
</member>
<member name="M:NPack.SingleComponent.Multiply(System.Single)">
<summary>
Multiplies the SingleComponent with Single and returns the product.
</summary>
<param name="a">The multiplier.</param>
<returns>
The product of the SingleComponent instance and
<paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.Divide(System.Single)">
<summary>
Divides the SingleComponent by a Single and returns the quotient.
</summary>
<param name="a">The divisor.</param>
<returns>
The quotient of dividing the SingleComponent instance
(the dividend) and <paramref name="a"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.GreaterThan(NPack.SingleComponent)">
<summary>
Evaluates if the SingleComponent instance is greater than
the given value.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the SingleComponent instance is greater
than <paramref name="value"/>; false otherwise.</returns>
</member>
<member name="M:NPack.SingleComponent.GreaterThanOrEqualTo(NPack.SingleComponent)">
<summary>
Evaluates if the SingleComponent instance is greater than
or equal to the given value.
</summary>
<param name="value">The value to compare to.</param>
<returns>
True if the SingleComponent instance is greater
than or equal to <paramref name="value"/>; false otherwise.
</returns>
</member>
<member name="M:NPack.SingleComponent.LessThan(NPack.SingleComponent)">
<summary>
Evaluates if the SingleComponent instance is less than
the given value.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the SingleComponent instance is less
than <paramref name="value"/>; false otherwise.</returns>
</member>
<member name="M:NPack.SingleComponent.LessThanOrEqualTo(NPack.SingleComponent)">
<summary>
Evaluates if the SingleComponent instance is less than
or equal to the given value.
</summary>
<param name="value">The value to compare to.</param>
<returns>
True if the SingleComponent instance is less
than or equal to <paramref name="value"/>; false otherwise.
</returns>
</member>
<member name="M:NPack.SingleComponent.GreaterThan(System.Single)">
<summary>
Evaluates if the SingleComponent instance is greater than
the given Single value.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the SingleComponent instance is greater
than <paramref name="value"/>; false otherwise.</returns>
</member>
<member name="M:NPack.SingleComponent.GreaterThanOrEqualTo(System.Single)">
<summary>
Evaluates if the SingleComponent instance is greater than
or equal to the given Single value.
</summary>
<param name="value">The value to compare to.</param>
<returns>
True if the SingleComponent instance is greater
than or equal to <paramref name="value"/>; false otherwise.
</returns>
</member>
<member name="M:NPack.SingleComponent.LessThan(System.Single)">
<summary>
Evaluates if the SingleComponent instance is less than
the given Single value.
</summary>
<param name="value">The value to compare to.</param>
<returns>True if the SingleComponent instance is less
than <paramref name="value"/>; false otherwise.</returns>
</member>
<member name="M:NPack.SingleComponent.LessThanOrEqualTo(System.Single)">
<summary>
Evaluates if the SingleComponent instance is less than
or equal to the given Single value.
</summary>
<param name="value">The value to compare to.</param>
<returns>
True if the SingleComponent instance is less
than or equal to <paramref name="value"/>; false otherwise.
</returns>
</member>
<member name="M:NPack.SingleComponent.Power(System.Double)">
<summary>
Raises the SingleComponent value to the given exponent.
<paramref name="power"/>.
</summary>
<param name="power">
The value of the exponent.
</param>
<returns>
The value of the SingleComponent (the base)
raised to the given power.
</returns>
</member>
<member name="M:NPack.SingleComponent.Sqrt">
<summary>
Computes the value of the square root of the SingleComponent.
</summary>
<returns>
The value of the square root of the SingleComponent.
</returns>
</member>
<member name="M:NPack.SingleComponent.Log(System.Double)">
<summary>
Computes the log of the SingleComponent in the
<paramref name="newBase">given base</paramref>.
</summary>
<param name="newBase">The base to compute the log in.</param>
<returns>
The log of the SingleComponent in the new base given.
</returns>
</member>
<member name="M:NPack.SingleComponent.Log">
<summary>
Computes the log of the SingleComponent in base e.
</summary>
<returns>The natural log of the SingleComponent.</returns>
</member>
<member name="M:NPack.SingleComponent.Exp">
<summary>
Computes e to the power of the SingleComponent.
</summary>
<returns>
The natural log base, e, raised to the power
of the value of the SingleComponent.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IExponential{System#Single}#Power(System.Double)">
<summary>
Raises the SingleComponent value to the given
exponent, returned as a Single.
<paramref name="power"/>.
</summary>
<param name="power">
The value of the exponent.
</param>
<returns>
The value of the SingleComponent (the base)
raised to the given power.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IExponential{System#Single}#Sqrt">
<summary>
Computes the value of the square root of the SingleComponent,
returned as a Single.
</summary>
<returns>
The value of the square root of the SingleComponent.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IExponential{System#Single}#Log(System.Double)">
<summary>
Computes the log of the SingleComponent in the
<paramref name="newBase">given base</paramref>,
returned as a Single.
</summary>
<param name="newBase">The base to compute the log in.</param>
<returns>
The log of the SingleComponent in the new base given.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IExponential{System#Single}#Log">
<summary>
Computes the log of the SingleComponent in base e,
returned as a Single.
</summary>
<returns>The natural log of the SingleComponent.</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IExponential{System#Single}#Exp">
<summary>
Computes e to the power of the SingleComponent,
returned as a Single.
</summary>
<returns>
The natural log base, e, raised to the power
of the value of the SingleComponent.
</returns>
</member>
<member name="M:NPack.SingleComponent.Abs">
<summary>
Computes the absolute value of the SingleComponent.
</summary>
<returns>
The absolute value of the SingleComponent's value.
</returns>
</member>
<member name="M:NPack.SingleComponent.Set(System.Double)">
<summary>
Sets the value of the SingleComponent.
</summary>
<param name="value">
The value to set the SingleComponent to, cast to a Single.
</param>
<returns>
A SingleComponent with the given <paramref name="value"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IComputable{System#Single}#Abs">
<summary>
Computes the absolute value of the SingleComponent,
returned as a Single.
</summary>
<returns>
The absolute value of the SingleComponent's value.
</returns>
</member>
<member name="M:NPack.SingleComponent.NPack#Interfaces#IComputable{System#Single}#Set(System.Double)">
<summary>
Computes the absolute value of the SingleComponent,
returned as a Single.
</summary>
<returns>
The absolute value of the SingleComponent's value.
</returns>
</member>
<member name="M:NPack.SingleComponent.GetTypeCode">
<summary>
Gets the TypeCode value for the SingleComponent.
</summary>
<returns><see cref="F:System.TypeCode.Single"/></returns>
</member>
<member name="M:NPack.SingleComponent.ToBoolean(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Boolean"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Boolean"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToByte(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Byte"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Byte"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToChar(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Char"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Char"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToDateTime(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.DateTime"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.DateTime"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToDecimal(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Decimal"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Decimal"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToDouble(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Double"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Double"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToInt16(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Int16"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Int16"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToInt32(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Int32"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Int32"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToInt64(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Int64"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Int64"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToSByte(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.SByte"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToSingle(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.Single"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.Single"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToString(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.String"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.String"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToType(System.Type,System.IFormatProvider)">
<summary>
Converts the SingleComponent to a value of the given type.
</summary>
<param name="conversionType">
Type to convert to.
</param>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>
The SingleComponent as a value of <paramref name="conversionType"/>.
</returns>
</member>
<member name="M:NPack.SingleComponent.ToUInt16(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.UInt16"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.UInt16"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToUInt32(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.UInt32"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.UInt32"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToUInt64(System.IFormatProvider)">
<summary>
Converts the SingleComponent to a <see cref="T:System.UInt64"/> value.
</summary>
<param name="provider">
An <see cref="T:System.IFormatProvider"/> instance used to
help convert the SingleComponent value.
</param>
<returns>The SingleComponent as a <see cref="T:System.UInt64"/>.</returns>
</member>
<member name="M:NPack.SingleComponent.ToString(System.String,System.IFormatProvider)">
<summary>
Generates a String representation of the SingleComponent.
</summary>
<param name="format">The format String to use in formatting.</param>
<param name="formatProvider">
An <see cref="T:System.IFormatProvider"/> instance used to
help format the SingleComponent value.
</param>
<returns>
A formatted String which represents the SingleComponent value.
</returns>
</member>
<member name="P:NPack.SingleComponent.Zero">
<summary>
Returns the zero value for a SingleComponent. Equal to 0F.
</summary>
</member>
<member name="P:NPack.SingleComponent.One">
<summary>
Returns the multiplicative identity.
</summary>
</member>
<member name="P:NPack.SingleComponent.NPack#Interfaces#IHasZero{System#Single}#Zero">
<summary>
Gets the additive identity as a Single: 0F.
</summary>
</member>
<member name="P:NPack.SingleComponent.NPack#Interfaces#IHasOne{System#Single}#One">
<summary>
Gets the multiplicative identity as a Single: 1F.
</summary>
</member>
<member name="T:NPack.Interfaces.IMultipliable`2">
<summary>
Every class that defines a * operation
like <c>TProduct operator * (IMultipliable`2 a, TFactor b)</c> should consider
implementing this interface.
</summary>
<typeparam name="TFactor">
Type which multiplies the <see cref="T:NPack.Interfaces.IMultipliable`2"/> instance.
</typeparam>
<typeparam name="TProduct">Result type of the multiplication operation.</typeparam>
<remarks>
Adapted from an article on lambda-computing.com:
http://www.lambda-computing.com/publications/articles/generics/IArithmetic.cs.
</remarks>
</member>
<member name="M:NPack.Interfaces.IMultipliable`2.Multiply(`0)">
<summary>
Returns the product of the Object and <paramref name="b"/>.
It must not modify the value of the Object.
</summary>
<param name="b">The factor to multiply by.</param>
<returns>The product.</returns>
</member>
<member name="T:NPack.Interfaces.IFactorization`2">
<summary>
Provides an interface for a factorization of a matrix.
</summary>
<typeparam name="TComponent">Type of matrix element.</typeparam>
<typeparam name="TMatrix">Type of matrix.</typeparam>
</member>
<member name="P:NPack.Interfaces.IFactorization`2.InputMatrix">
<summary>
Gets the matrix which was factored (or decomposed).
</summary>
</member>
<member name="T:NPack.Interfaces.IVector`2">
<summary>
A vector.
</summary>
<typeparam name="TComponent">Type of components in the vector.</typeparam>
<typeparam name="TVector">Type of vector.</typeparam>
</member>
<member name="T:NPack.Interfaces.IMatrix`1">
<summary>
An interface to a generic matrix.
</summary>
<typeparam name="T">Type of element in the matrix.</typeparam>
</member>
<member name="M:NPack.Interfaces.IMatrix`1.Clone">
<summary>
Makes an element-by-element copy of the matrix.
</summary>
<returns>An exact copy of the matrix.</returns>
</member>
<member name="M:NPack.Interfaces.IMatrix`1.GetMatrix(System.Int32[],System.Int32,System.Int32)">
<summary>
Gets a submatrix.
</summary>
<param name="rowIndexes">The indexes of the rows to include.</param>
<param name="startColumn">The starting column to include.</param>
<param name="endColumn">The ending column to include.</param>
<returns>
A submatrix with rows given by <paramref name="rowIndexes"/> and columns
<paramref name="startColumn"/> through <paramref name="endColumn"/>.
</returns>
</member>
<member name="M:NPack.Interfaces.IMatrix`1.Transpose">
<summary>
Returns the transpose of the matrix.
</summary>
<returns>The matrix with the rows as columns and columns as rows.</returns>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.Determinant">
<summary>
Gets the determinant for the matrix, if it exists.
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.ColumnCount">
<summary>
Gets the number of columns in the matrix.
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.Format">
<summary>
Gets the format of the matrix, either row-major or column-major.
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.IsSingular">
<summary>
Gets true if the matrix is singular (non-invertible).
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.IsInvertible">
<summary>
Gets true if the matrix is invertible (non-singular).
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.Inverse">
<summary>
Gets the inverse of the matrix, if one exists.
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.IsSquare">
<summary>
Gets true if the matrix is square (<c>RowCount == ColumnCount != 0</c>).
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.IsSymmetrical">
<summary>
Gets true if the matrix is symmetrical.
</summary>
</member>
<member name="P:NPack.Interfaces.IMatrix`1.RowCount">
<summary>
Gets the number of rows in the matrix.