-
Notifications
You must be signed in to change notification settings - Fork 12
/
IEEEtran.cls
4572 lines (4068 loc) · 192 KB
/
IEEEtran.cls
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
%%
%% IEEEtran.cls 2002/11/18 version V1.6b
%%
%% NOTE: This text file uses UNIX line feed conventions. When (human)
%% reading this file on other platforms, you may have to use a text
%% editor that can handle lines terminated by the UNIX line feed
%% character (0x0A).
%%
%%
%% This is the official IEEE LaTeX class for authors of the Institute of
%% Electrical and Electronics Engineers (IEEE) Transactions journals and
%% conferences.
%%
%% The latest version and documentation of IEEEtran can be obtained at:
%% http://www.ieee.org
%% and/or
%% http://www.ctan.org/tex-archive/macros/latex/contrib/supported/IEEEtran/
%%
%% The CTAN page may have additional files related to obscure,
%% non-IEEE standard and/or platform dependent use of this tool.
%%
%% Based on the original 1993 IEEEtran.cls, but with many bug fixes
%% and enhancements (from both JVH and MDS) over the 1996/7 version.
%%
%%
%% Contributors:
%% Gerry Murray (1993), Silvano Balemi (1993),
%% Jon Dixon (1996), Peter N"uchter (1996),
%% Juergen von Hagen (2000), and Michael Shell (2001-2002)
%%
%%
%% Copyright (c) 1993-2002 by Gerry Murray, Silvano Balemi,
%% Jon Dixion, Peter N"uchter,
%% Juergen von Hagen and Michael Shell
%%
%% Current maintainer (V1.3 to V1.6): Michael Shell
%% See the CTAN website above
%% for current contact information.
%%
%% Special thanks to Peter Wilson (CUA) and Donald Arseneau
%% for allowing the inclusion of the \@ifmtarg command
%% from their ifmtarg LaTeX package.
%%
%%**********************************************************************
%% Legal Notice:
%% This code is offered as-is without any warranty either
%% expressed or implied; without even the implied warranty of
%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE!
%% User assumes all risk.
%% In no event shall IEEE or any contributor to this code
%% be liable for any damages or losses, including, but not limited to,
%% incidental, consequential, or any other damages, resulting from the
%% use or misuse of any information contained here.
%%
%% All comments are the opinions of their respective authors and are not
%% necessarily endorsed by the IEEE.
%%
%% This code is distributed under the Perl Artistic License
%% ( http://language.perl.com/misc/Artistic.html )
%% and may be freely used, distributed and modified.
%% Retain the contribution notices and credits.
%%
%% Major changes to the user interface should be indicated by an
%% increase in the version numbers. If a version is a beta, it will
%% be indicated with a BETA suffix, i.e., 1.4 BETA.
%% Small changes can be indicated by appending letters to the version
%% such as "IEEEtran_v14a.cls".
%% In all cases, \Providesclass, any \typeout messages to the user,
%% \IEEEtransversionmajor and \IEEEtransversionminor must reflect the
%% correct version information.
%% The changes should also be documented via source comments.
%%**********************************************************************
%%
%
% Available class options
% (e.g., \documentclass[10pt,conference]{IEEEtran}
%
% *** choose only one from each category ***
%
% 9pt, 10pt, 11pt, 12pt
% Sets normal font size. The default is 10pt.
%
% conference, journal, technote, peerreview, peerreviewca
% determines format mode - conference papers, journal papers,
% correspondence papers (technotes), or peer review papers. The user
% should also select 9pt when using technote. peerreview is like
% journal mode, but provides for a single-column "cover" title page for
% anonymous peer review. The paper title (without the author names) is
% repeated at the top of the page after the cover page. For peer review
% papers, the \IEEEpeerreviewmaketitle command must be executed (will
% automatically be ignored for non-peerreview modes) at the place the
% cover page is to end, usually just after the abstract (keywords are
% not normally used with peer review papers). peerreviewca is like
% peerreview, but allows the author names to be entered and formatted
% as with conference mode so that author affiliation and contact
% information can be easily seen on the cover page.
% The default is journal.
%
% draft, draftcls, draftclsnofoot, final
% determines if paper is formatted as a widely spaced draft (for
% handwritten editor comments) or as a properly typeset final version.
% draftcls restricts draft mode to the class file while all other LaTeX
% packages (i.e., \usepackage{graphicx}) will behave as final - allows
% for a draft paper with visible figures, etc. draftclsnofoot is like
% draftcls, but does not display the date and the word "DRAFT" at the foot
% of the pages. If using one of the draft modes, the user will probably
% also want to select onecolumn.
% The default is final.
%
% letterpaper, a4paper
% determines paper size: 8.5in X 11in or 210mm X 297mm. CHANGING THE PAPER
% SIZE WILL NOT ALTER THE TYPESETTING OF THE DOCUMENT - ONLY THE MARGINS
% WILL BE AFFECTED. In particular, documents using the a4paper option will
% have reduced side margins (A4 is narrower than US letter) and a longer
% bottom margin (A4 is longer than US letter). For both cases, the top
% margins will be the same and the text will be horizontally centered.
% For final submission to IEEE, authors should use US letter (8.5 X 11in)
% paper. Note that authors should ensure that all post-processing
% (ps, pdf, etc.) uses the same paper specificiation as the .tex document.
% Problems here are by far the number one reason for incorrect margins.
% IEEEtran will automatically set the default paper size under pdflatex
% (without requiring a change to pdftex.cfg), so this issue is more
% important to dvips users. Fix config.ps, config.pdf, or ~/.dvipsrc for
% dvips, or use the dvips -t papersize option instead as needed. See the
% testflow documentation
% http://www.ctan.org/tex-archive/macros/latex/contrib/supported/IEEEtran/testflow
% for more details on dvips paper size configuration.
% The default is letterpaper.
%
% oneside, twoside
% determines if layout follows single sided or two sided (duplex)
% printing. The only notable change is with the headings at the top of
% the pages.
% The default is oneside.
%
% onecolumn, twocolumn
% determines if text is organized into one or two columns per page. One
% column mode is usually used only with draft papers.
% The default is twocolumn.
%
% nofonttune
% turns off tuning of the font interword spacing. Maybe useful to those
% not using the standard Times fonts or for those who have already "tuned"
% their fonts.
% The default is to enable IEEEtran to tune font parameters.
%
%
%*******
% 11/2002 V1.6b (MDS) changes:
%
% 1) Fixed problem with figure captions when using hyperref. Thanks to
% Leandro Barajas and Michael Bassetti for reporting this bug.
%
% 2) Provide a fake nabib command \NAT@parse so that hyperref will not
% interfere with the operation of cite.sty. However, as a result citation
% numbers will not be hyperlinked. Also, natbib will not be able to work
% with IEEEtran. However, this is perhaps the best solution until cite.sty
% and hyperref.sty are able to co-exist with each other.
% It easy enough to override the fake command via:
% \makeatletter
% \let\NAT@parse\undefined
% \makeatother
%
% 3) Revised font selection method so as not to have problems when used
% with setspace.sty. Thanks to Zhang Yan for reporting this bug.
%
% 4) Added \special to feed papersize to dvips. Thanks to Moritz Borgmann
% for suggesting this feature.
%
% 5) In addition to the IEEE IED lists, the original IED style list
% environments (as is done in article.cls) are now provided as
% LaTeXitemize, LaTeXenumerate, and LaTeXdescription. Also, users can
% now redefine \makelabel within IEEE IED list controls. There may be
% some use for this in specialized applications. Thanks to Eli Barzilay
% for suggesting this feature.
%
% 6) \table* now defaults to \footnotesize text like \table.
%
% 7) The draft modes now no longer force a pagebreak after the title.
% Thanks to Christian Peel for suggesting this change.
%
% 8) New draftclsnofoot mode is like draftcls, but does not display the
% date and the word "DRAFT" at the foot of the page. Thanks to
% Christian Peel for suggesting this feature.
%
% 9) New peerreview and peerreviewca modes with \IEEEpeerreviewmaketitle
% command allows for a "cover" titlepage for anonymous peer review.
% Except for the cover titlepage, peerreview is much like journal mode.
% peerreviewca is like peerreview, but allows the author names to be
% entered and formatted as under conference mode so that author
% affiliations and contact information can be easily seen on the cover
% page. Thanks to Eric Benedict for suggesting this feature.
%
%
%*******
% 7/2002 V1.6 (MDS) changes:
%
% 1) Added conference mode via conference option. Defaults to the traditional
% journal mode. i.e., \documentclass[conference]{IEEEtran}
%
% 2) Added support for A4 paper via new a4paper option. Pdflatex's paper size
% lengths are now automatically set to the proper paper size being used.
%
% 3) Revised margins again. Page text is now horizontally centered.
% Conference mode increases the top and bottom margins with the bottom
% margin being slightly larger. For A4 paper, the top margin and text
% typesetting will not change from those of US letter paper, but the side
% margins will be smaller and the bottom margin will be larger than that of
% US letter. All per IEEE specs.
%
% 4) Fixed footnote line spacing anomaly in draft mode.
% Thanks to Alberto Rodriguez for reporting this bug.
%
% Also, slightly revised footnote and \thanks note spacing.
% Set \interfootnotelinepenalty=10000 to prevent LaTeX
% from breaking footnotes across multiple pages or columns.
%
% 5) Fixed bug that caused overwritten photo areas and sometimes anomalous
% spacing when a new paragraph was started within a biography. Also,
% the presence of \par's, new lines or spaces at the beginning of
% abstract, keywords, biography, or biographynophoto will no longer
% affect the first word spacing.
% Thanks to Eric Durant for reporting this bug.
%
% The biography environment now does a better job in preventing
% a biography photo area from being broken across pages or columns.
%
% 6) Fixed whitespace between \cite entries bug. i.e.,
% both \cite{einstein24, knuth84} and \cite{einstein24,knuth84}
% are now valid. \cite is now a robust command as it should be.
% IEEEtran now no longer defines the old non-standard \shortcite or
% \citename.
%
% The base IEEEtran.cls does not sort citation numbers or produce ranges
% for three or more consecutive numbers. However, V1.6 of IEEEtran.cls
% now pre-defines the following format control macros to facilitate easy
% use with Donald Arseneau's cite.sty package (tested with cite.sty V3.9):
%
% \def\citepunct{], [}
% \def\citedash{]--[}
%
% cite.sty is standard on most LaTeX sytems and can be obtained from
% www.ctan.org. Thanks to Donald Arseneau for creating cite.sty, providing
% the required format arguments to produce the IEEE style. and
% designing a cite interface capable of handling the IEEE citation
% style.
%
% Note: Historically, IEEE has wanted authors to "hardcode" symbolics.
% (i.e., replace all \cite{} with fixed [x]). However, it now seems that
% most electronic manuscript submissions to IEEE are in .pdf format, and
% as such, do not require the LaTeX document reference numbers to be hard
% coded. If an author is required to submit actual LaTeX files, I do
% recommend that the bibliography file (.bbl) be copied into the .tex
% document and the \bibliographystyle{} and \bibliography{} commands be
% commented out so that the .tex file does not depend on (potentially
% lengthy and/or confidential) external bibliography database files.
%
% 7) Adjusted some spacing parameters. The spacing above and below equations
% has been revised (to a typical IEEE value). \jot now has a decent value.
% The title text is now exactly 24pt. (On a related note, \fontsubfuzz has
% been increased to 0.9pt to prevent annoying font substitution warnings
% when using the Computer Modern fonts that use the 24.88pt size.)
% In V1.6, \small is now 8.5pt in 9pt docs because \footnotesize is 8pt.
% For 9pt docs, you should probably go ahead and use \footnotesize when you
% need text a little smaller than \normalsize.
% The interword spacing has been adjusted to be extremely close to that
% which IEEE uses. You can use a new class option, nofonttune, if you need
% to disable the adjusting of the interword spacing. This adjustment and
% an increase to \hyphenpenalty have greatly reduced the amount of
% hyphenation in a typical paper.
% The baselineskip for the normalsize fonts has been tweaked to reduce
% underfull vboxes on journal paper columns with only paragraphs.
% Conference mode does the same thing but by also tweaking the \textheight
% slightly off 9.25in (IEEE spec) to ensure an integer number of lines per
% page. Draft (also draftcls) mode has also been revised to reduce
% underfull vbox warnings. However, draft mode can still produce underfull
% vboxes (a direct result of the increase in line spacing and margins) if:
% A non-normalsize font occupies an entire column (abstract and index terms
% take up a whole column by themselves); or the beginning of a section
% occurs near the end of a column and cannot be squeezed into the bottom,
% etc. This is normal as draft mode's liberal spacings cannot guarantee
% perfect formatting.
%
% 8) New biographynophoto environment for biographies without photos.
% Usage:
%
% \begin{biographynophoto}{author name}
% biography text here
% \end{biographynophoto}
%
% 9) Fixed bug that produced multiple table of contents entries for papers
% with more than one biography. Also, biography now works better with
% hyperref.
%
%10) New \sublargesize font size command provides for 11pt text in a 10pt
% document. (Needed for things like author names.) For documents not
% using 10pt normal size text, \sublargesize is currently identical
% to \large.
%
%11) New \IEEEmembership command to provide correct font to indicate IEEE
% membership for journal papers.
%
%12) Fixed author name line overflow problem when in journal mode. This
% problem had been introduced in V1.5 in my rush to get \and to work for
% conferences. \and is unneeded (and invalid) in journal mode. For
% conference mode, \and will work as expected and features an optional
% spacing argument. i.e., \and[\hspace{5ex}]
% \and will default (recommended) to using \hfill which will result in
% equal spacing between author blocks.
%
%13) New \authorblockN, \authorblockA and \authorrefmark commands to
% facilitate easy formatting of author names, affiliations and cross
% reference symbols, respectively, when in conference mode. These
% three commands are to be used only for conference papers.
% In conference mode, \author text is placed within a modified tabular
% environment (somewhat like article.cls). So, within \author in conference
% mode, you should not try to enclose multiple \\ within an environment or
% command (other than the argument braces of \authorblockX{}). For example:
%
% \author{\authorblockN{{John Doe \\ Jane Doe}}} % WRONG!
%
% will generate an error.
%
% Note that font size/attribute changes will now persists across \\ within
% \author. (But, not across author blocks nor across \and.)
% However, with the new commands, there should be no need to alter any
% font attributes within \author. All text sizing and spacing within
% \author{} and the author block commands is per IEEE specs for both
% conference and journal modes. (In conference mode, the author names
% are only very slightly larger than the affiliations which are in normal
% size.) For specialized applications you can alter the justification of
% author lines by placing \hfill at the beginning or at the end of a line.
% The interline spacing within \author is determined by the font attributes
% that are in effect at the end of each line within author.
%
%14) Because the titles and author name blocks use different font sizes/styles
% from the main text, it was possible that two column papers with titles that
% span both columns (standard journal and conference papers, but not technotes)
% with certain numbers of lines for the title and authors' name/affiliations
% can cause underfull vbox problems (paragraphs with large spacings between
% them) in the second column of the main text on the title page - if there were
% no new sections, equations or figures in this column (they would provide some
% needed rubber spacing). The use of things like special paper notices and
% publisher ID marks also affected this issue. The problem could not happen
% in the first column because the first column has a rubber length around the
% heading of the first section. Furthermore, problems seldom occurred on pages
% after the first as the margins had been chosen not to cause it with the popular
% font sizes. Rubber lengths after the author names would not fix this problem.
% Auto-calculating a "good" spacing after the title is a tad difficult
% to do in LaTeX. However, I am pleased to report that V1.6 has this new
% capability - "dynamically determined title spacing". IEEEtran will now
% measure the height of all the title and author text in \maketitle
% and then calculate a rigid (non-rubber) spacer to follow that meets
% IEEE specs and also produces a \textheight on the title page that ensures
% an integer number of normalsized lines on the rest of the page. Single
% column papers, and two column papers with the title entirely in column
% one (technotes) do not need dynamic rigid spacing and therefore use
% standard rubber spacers.
%
% Note: This problem can still crop up if you use floats that span both
% columns (i.e., figure*). It has been a decade+ long limitation with LaTeX
% that the stretchable portion of \dbltextfloatsep is ignored.
% If you get a problem with underful vbox warnings and paragraphs that "are
% pulled apart" on page with a float that spans both columns, tweak the
% space between the figure and the main text a little:
%
% \vskip 5pt
% \end{figure*}
%
% If you can't find a value that fixes both columns, you are going to
% have to put a rubber spacer somewhere in one or both of the columns.
%
%15) Because of change #14 above, those of you using \pubid will, as of V1.6,
% have to place it *before* \maketitle in order for it have the intended
% affect. The dynamic spacer algorithm must see if you are using \pubid when
% \maketitle is called. \pubidadjcol works as before except that it now
% has additional logic to prevent it from doing anything if \pubid was never
% called.
%
%16) In some unusual, non-standard circumstances, an author may desire to
% alter the spacing after the title area or put some unusual text above
% the main text. For instance, to stop a bad break when a new section
% occurs right at the start of the second page. This is difficult to do
% when the title spans both columns of two column text since LaTeX treats
% such title text as a type of float. A new command, \IEEEaftertitletext{},
% gives access to the end of that produced by \maketitle. The types of
% things that can go into \IEEEaftertitletext are the same as those into
% \twocolumn[] - no \par, but \\ are OK. There is no restriction on the
% range of spacings that can be used.
% i.e., \IEEEaftertitletext{\vspace{-100pt}} will push the main text well
% into the title and \IEEEaftertitletext{\vspace{100pt}} will push it far down
% the page. You will have complete control. If used, place
% \IEEEaftertitletext{} before \maketitle like \title and \author. IEEEtran's
% dynamic title spacing intentionally does not take into consideration the
% contents of \IEEEaftertitletext{} when determining the spacer after the title
% area (otherwise it would try to second guess you), so the user will have
% manually adjust the height of the contents in \IEEEaftertitletext{} if the
% problem discussed in #14 above should develop. A safe bet is to keep
% the height of contents of \IEEEaftertitletext{} to integer multiples of
% \baselineskip, i.e., \IEEEaftertitletext{\vspace{-1\baselineskip}}
%
% Because it can result in an IEEE nonstandard format, the use of
% \IEEEaftertitletext{} is discouraged. Possible uses include (1) the use of
% IEEEtran for non-IEEE work with different title spacing requirements,
% or (2) as an emergency manual override if a problem should develop in
% IEEEtran's automatic spacing algorithm.
%
%17) completely rewritten \PARstart to:
% a. no longer have problems when the user begins an environment
% within the paragraph that uses \PARstart.
% b. auto-detect and use the current font family
% c. revise handling of the space at the end of the first word so that
% interword glue will now work as normal.
% d. produce correctly aligned edges for the (two) indented lines.
%
% Because the current font family is now auto-detected, there is no
% longer any need for \CMPARstart - it is now the same as \PARstart.
%
%18) There is now a new "open box" Q.E.D. symbol (\QEDopen) as well as the
% original default (\QED) closed one (\QEDclosed). Some journals use
% the open form. To make \proof use the open form, just do:
% \renewcommand{\QED}{\QEDopen}
%
%19) Additional \typeout{} notices added to warn the user when unusual
% settings/commands are detected or as reminders to avoid common errors
% when in conference mode.
%
%20) IEEEtran now provides \abovecaptionskip and \belowcaptionskip skip
% registers because article class provides them and some packages
% may error if they are missing. However, IEEEtran only uses
% \abovecaptionskip for actual caption spacing.
%
%21) Fixed bug that prevented users from redefining the section headings
% to use arabic digits. Thanks to Richardt H. Wilkinson for reporting
% this bug.
%
%22) Code cleaned up to be more efficient with the use of TeX registers;
% removed some old LaTeX 2.09 code; revised option processing to
% LaTeX2e standard; eliminated unwanted "phantom" spaces in some
% environments.
%
%23) Added new \IEEEeqnarray, \IEEEeqnarraybox, \IEEEeqnarrayboxm and
% \IEEEeqnarrayboxt environments to provide superior alternatives to the
% standard LaTeX \eqnarray, \array and \tabular. Additional new support
% commands include \IEEEeqnarraydecl, \IEEEeqnarrayboxdecl,
% \IEEEeqnarraymathstyle, \IEEEeqnarraytextstyle, \yesnumber. \IEEEnonumber,
% \IEEEyesnumber, \IEEEyessubnumber, \IEEEeqnarraynumspace, \IEEEeqnarraymulticol,
% \IEEEeqnarrayomit, \IEEEeqnarraydefcol, \IEEEeqnarraydefcolsep, \IEEEeqnarrayseprow,
% \IEEEeqnarrayseprowcut, \IEEEeqnarrayrulerow, \IEEEeqnarraydblrulerowcut,
% \IEEEeqnarraystrutmode, \IEEEeqnarraystrutsize, \IEEEeqnarraystrutsizeadd,
% \IEEEvisiblestrutstrue, \IEEEvisiblestrutsfalse and \IEEEstrut.
% These are documented in the user's guide.
%
%24) V1.6 changed back to using () around theorem names (which are also now in italics)
% as this is what IEEE is using now. Thanks to Christian Peel for reporting this.
% Also, when section numbers are used as the first part of theorem numbers, display
% them in arabic, not Roman.
%
%25) New \IEEEtriggeratref{X} command allows a page break to be triggered just
% before the given reference number "X". This is most useful when balancing
% the columns on the last page and a \newpage between references is desired.
% \IEEEtriggercmd{X} allows a different command to be executed at trigger.
%
%
%*******
% 7/2001 V1.5 (MDS) changes:
%
%
% 1) Fixed \and within \author bug: (! Misplaced \crcr. \endtabular ->\crcr)
% Thanks to Rainer Dorsch for discovering and reporting that \and
% did not work.
%
% 2) Fixed the biography environment so that if a biography's text is shorter
% than the area allocated for the photo, a collision with the next
% biography does not occur. You can now put real graphics (using the
% graphicx package) into the biography photo box with a new optional
% argument of the biography command! For example:
%
% \begin{biography}[{\includegraphics[width=1in,height=1.25in,clip,keepaspectratio]{./tux.eps}}]{Linux Penguin}
%
% will use the specified graphic as the author's photo. The photo area is
% exactly 1in wide by 1.25in high - as is done in IEEE Transactions. Try
% to keep the same 4:5 aspect ratio if scanning/cropping your photos.
% Note the need for the extra set of enclosing braces around the
% \includegraphics. Without it, The LaTeX parser may get confused when it
% sees the \includegraphics's brackets within the biography's optional
% argument. Due to the length of the \includegraphics command, you may wish
% to define your own shorthand form of it. I have not done so with IEEEtran
% to prevent dependence on the graphicx package. If you do not use the
% optional argument, or leave it empty, a standard frame box with the
% words "Place Photo Here" will be used. If you want the space to remain
% completely empty, you can do:
%
% \begin{biography}[\mbox{}]{The Invisible Man}
%
% The interface to biography's optional argument is into a
% 1in X 1.25in minipage in which the argument text is centered both
% horizontally and vertically:
%
% \begin{minipage}[b][1.25in][c]{1in}%
% \centering
% #1%
% \end{minipage}
%
% Within the biography environment, \unitlength is set to 1in.
% With this in mind, you can even design your own custom frameboxes.
% For instance:
%
% \begin{biography}[\framebox(1,1.25){\parbox[][\height][c]{0.9in}{\centering PLACE\\ PHOTO\\ HERE}}]{Author Name}
%
% will yield the same type of result as the default photo box.
%
% Thanks to Herbert Voss for discovering the collision bug, suggesting the ability
% to handle graphics and providing some prototype code.
%
%
%
%*******
% 3/2001 V1.4 (MDS) changes:
%
%
% 1) New "draftcls" and "final" options have been added.
% Thanks to Dragan Cvetkovic for suggesting an option like draftcls.
%
% 2) Documentation changes to reflect the fact that this IEEEtran.cls
% is no longer beta test.
%
% 3) Slightly revised caption sizes. Figure and table captions are now
% in \footnotesize, not \small as before.
%
% 4) Allow user to control figure caption justification. IEEEtran.cls
% normally defaults to left justified as is done in Transactions.
% However, for conferences, you may wish to issue the command:
% \centerfigcaptionstrue
% in the preamble. Short (less than one line long) figure captions
% will then be centered. Multi-line figure captions will always be
% properly left justified. V1.6: This is already done for you when
% using the conference mode.
%
%
%
%*******
% 1/2001 V1.3
% Michael Shell (MDS) made extensive changes and additions:
%
%
% BUGS FIXED (and many others too numerous to mention!):
% 1) Fixed improper alignment with itemized, enumerated and
% description lists. Added new controls to these three
% environments so that it is easy to get the alignment IEEE
% uses. Furthermore, the itemize, enumerate and description lists
% no longer force a new paragraph to begin at the end the list
% (\par). (Sometimes lists are used within paragraphs.)
%
% 2) JVH's fixes now allow things like $\mathbf{N}(0,P(0))$
% to work properly without needing the extra braces:
% ${\mathbf{N}}(0,P(0))$. There is no longer any dependence
% on the "rawfonts" and "oldlfont" packages. Thanks Juergen!
%
% 3) Fixed underfull hbox errors and incorrect reference number
% alignment when the number of references in the bibliography
% exceeded 9 entries (which is almost every paper!).
%
% 4) Removed dependence on the LaTeX sizexx.clo files.
% Now, 9pt documents should work correctly even on systems that
% lack a size9.clo file. This is most often used in conjunction
% with the option "technote" for "correspondence" papers like those
% in IEEE Transactions on Information Theory. For virtually all
% other papers, 10pt is used and so it is the default.
% Some improper font sizes have been corrected. \footnotesize is
% now 8pt in 9pt docs, so footnotes in technotes should be the
% correct size now.
%
% 5) Added \interlinepenalty within the bibliography section to discourage
% LaTeX from breaking within a reference. IEEE almost never breaks within
% a reference and when they do it is usually in technotes
% (correspondence papers). You may get an underfull vbox warning in the
% bibliography indicating that the spacing just before the "REFERENCES"
% section is larger than normal, but the final result will be more like
% what IEEE will publish. See the comments in the BIBLIOGRAPHY section
% around line 2034 below if you want to change this behavior.
%
% 6) No longer "blows up" when you use \paragraph and have a table
% of contents.
%
% 7) Theorem environment changed, (but for V1.6, back to the old way, sigh).
%
% 8) Figure captions adjusted: IEEE left (not center) justifies
% figure captions (for journals) and does not indent figure caption text.
%
% 9) Adjusted some spacings in the table of contents(TOC))/list-of-figures/
% list-of-tables so that section/table numbers will not so easily
% collide with the titles. Section VIII was usually the worst offender.
% Still doesn't right justify the section numbers, but neither does
% article.cls (This must be why LaTeX likes the x.y.z section numbering
% scheme unlike I, II, III, etc. of IEEE. )
% It may be "normal" as it is (left justified). sigh.
%
%10) Now uses "index terms" now as a heading instead of "keywords".
% Furthermore, the "index terms" and "abstract" headings are in bold
% italic. This is how IEEE does things.
%
%11) \thebibliography and \biography now put entries into
% the table of contents for you.
%
% *******
%
%
%
%
%
% *******
% 9/2000 (JVH) changes: (now designated as V1.2)
%
% made some corrections to get closer to LaTeX2e
% 20000906 Juergen v.Hagen
%
% Permission to redistribute granted as of December 2000.
% *******
%
%
%
%
%
% *******
%
% 1996 (JWD) LaTeX2e version: (now designated as V1.1)
%
% In the most recent TeXhax digest, there was a request for a copy of
% IEEEtrans.sty modified to work with LaTeX2e. I have a version I
% modified to make it IEEEtrans.cls, which I have sent to the person
% making the request and am now sending to you to consider posting to
% the archives.
% --
% Jon Dixon
% http://spot.colorado.edu/~dixonj/
%
%*******
%
%
%
%
%
%*******
%
% 30-August-1993 original LaTeX 2.09 version (IEEEtran.sty),
% (now designated as V1.0):
%
% by Gerry Murray and Silvano Balemi
% Automatic Control Lab, ETH Zurich, Switzerland
%
%*******
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%
%
%
%
\ProvidesClass{IEEEtran}[2002/11/18 revision V1.6b by Michael Shell]
\typeout{-- See the "IEEEtran_HOWTO" manual for usage information.}
\typeout{-- The source comments contain changelog notes.}
\NeedsTeXFormat{LaTeX2e}
% define new needed flags to indicate document options
% and set a few "failsafe" defaults
\newif\if@twocolumnmode \global\@twocolumnmodetrue
\newif\if@draftversion \global\@draftversionfalse
\newif\if@draftclsmode \global\@draftclsmodefalse
\newif\if@draftclsmodefoot \global\@draftclsmodefootfalse
\newif\if@confmode \global\@confmodefalse
\newif\if@peerreviewoption \global\@peerreviewoptionfalse
\newif\if@peerreviewcaoption \global\@peerreviewcaoptionfalse
% we HAVE to turn off technote as there is no
% "not a tech note" option
\newif\if@technote \global\@technotefalse
% V1.6 we allow the user to control whether or not the
% font interword spacings are tuned to be more like
% that of IEEE. The default is to tune things.
\newif\if@fonttunesettings \global\@fonttunesettingstrue
% V1.6b flag to show if using a4paper
\newif\if@IEEEusingAfourpaper \global\@IEEEusingAfourpaperfalse
% IEEEtran class scratch pad registers
% dimen
\newdimen\@IEEEtrantmpdimenA
\newdimen\@IEEEtrantmpdimenB
% count
\newcount\@IEEEtrantmpcountA
\newcount\@IEEEtrantmpcountB
% token list
\newtoks\@IEEEtrantmptoksA
% we use \@IEEEptsize so that we can ID the point size (even for 9pt docs)
% as well as LaTeX's \@ptsize to retain some compatability with some
% external packages
\def\@IEEEptsize{10}
\def\@ptsize{0}
% LaTeX does not support 9pt, so we set \@ptsize to 0 - same as that of 10pt
\DeclareOption{9pt}{\def\@IEEEptsize{9}\def\@ptsize{0}}
\DeclareOption{10pt}{\def\@IEEEptsize{10}\def\@ptsize{0}}
\DeclareOption{11pt}{\def\@IEEEptsize{11}\def\@ptsize{1}}
\DeclareOption{12pt}{\def\@IEEEptsize{12}\def\@ptsize{2}}
% \@IEEEmarginE is the side margin for equal margins
% \@IEEEmarginW is the wider side margin when the margins are not equal
% NOTE: BOTH of the above margins are as they appear
% on the paper - they are NOT offset by 1 inch
\DeclareOption{letterpaper}{\setlength{\paperheight}{11in}%
\setlength{\paperwidth}{8.5in}%
\def\@IEEEmarginE{0.680in}%
\def\@IEEEmarginW{0.775in}%
\@IEEEusingAfourpaperfalse}
\DeclareOption{a4paper}{\setlength{\paperheight}{297mm}%
\setlength{\paperwidth}{210mm}%
\def\@IEEEmarginE{14.32mm}%
\def\@IEEEmarginW{17mm}
\@IEEEusingAfourpapertrue}
\DeclareOption{oneside}{\@twosidefalse \@mparswitchfalse}
\DeclareOption{twoside}{\@twosidetrue \@mparswitchtrue}
\DeclareOption{onecolumn}{\global\@twocolumnmodefalse}
% the file twocolumn.sty is not read as it changes \textwidth.
\DeclareOption{twocolumn}{\global\@twocolumnmodetrue}
% If the user selects draft, then this class AND any packages
% will go into draft mode.
\DeclareOption{draft}{\global\@draftversiontrue \global\@draftclsmodetrue
\global\@draftclsmodefoottrue}
% draftcls is for a draft mode which will not affect any packages
% used by the document.
\DeclareOption{draftcls}{\global\@draftversionfalse \global\@draftclsmodetrue
\global\@draftclsmodefoottrue}
% draftclsnofoot is like draftcls, but without the footer.
\DeclareOption{draftclsnofoot}{\global\@draftversionfalse \global\@draftclsmodetrue
\global\@draftclsmodefootfalse}
% we provide a final option just for completeness (article.cls has one)
\DeclareOption{final}{\global\@draftversionfalse \global\@draftclsmodefalse
\global\@draftclsmodefootfalse}
\DeclareOption{journal}{\global\@peerreviewoptionfalse \global\@peerreviewcaoptionfalse
\global\@confmodefalse \global\@technotefalse}
\DeclareOption{conference}{\global\@peerreviewoptionfalse \global\@peerreviewcaoptionfalse
\global\@confmodetrue \global\@technotefalse}
\DeclareOption{technote}{\global\@peerreviewoptionfalse \global\@peerreviewcaoptionfalse
\global\@confmodefalse \global\@technotetrue}
\DeclareOption{peerreview}{\global\@peerreviewoptiontrue \global\@peerreviewcaoptionfalse
\global\@confmodefalse \global\@technotefalse}
\DeclareOption{peerreviewca}{\global\@peerreviewoptiontrue \global\@peerreviewcaoptiontrue
\global\@confmodefalse \global\@technotefalse}
\DeclareOption{nofonttune}{\global\@fonttunesettingsfalse}
% IEEE uses Times font, so we'll default to times.
% These three commands make up the entire times.sty package.
\renewcommand{\sfdefault}{phv}
\renewcommand{\rmdefault}{ptm}
\renewcommand{\ttdefault}{pcr}
% enable Times now - so that all class options can see the correct font families
\normalfont\selectfont
% default to US letter paper, 10pt, twocolumn, one sided, final, journal
\ExecuteOptions{letterpaper,10pt,twocolumn,oneside,final,journal}
% overrride these defaults per user requests
\ProcessOptions
% we can send console reminder messages to the user here
\AtEndDocument{\if@confmode%
\typeout{}%
\typeout{** Conference Paper **}%
\typeout{Before submitting the final camera ready copy, remember to:}%
\typeout{}%
\typeout{ 1. Manually equalize the lengths of two columns on the last page}%
\typeout{ of your paper;}%
\typeout{}%
\typeout{ 2. Ensure that any PostScript and/or PDF output post-processing}%
\typeout{ uses only Type 1 fonts and that every step in the generation}%
\typeout{ process uses the US letter (8.5in X 11in) paper size.}%
\typeout{}%
\fi}
% warn about the use of single column other than for draft mode
\if@twocolumnmode\else%
\if@draftclsmode\else%
\typeout{** ATTENTION: Single column mode is not normally used with IEEE publications.}%
\fi%
\fi
% V1.6, if the user is using pdflatex, go ahead and set the output paper size.
% Otherwise, we declare the papersize via a \special for dvips.
% We keep the tests within braces because otherwise, if not using pdflatex,
% \pdfpageheight and \pdfpagewidth will be set to \relax - possibly affecting
% similar tests of other packages.
{\@ifundefined{pdfpageheight}{% not using pdflatex, setup paper size for dvips
\if@IEEEusingAfourpaper
\special{papersize=210mm,297mm}%
\else
\special{papersize=8.5in,11in}%
\fi}%
{% using pdftex, set paper size for pdftex
\global\pdfpageheight\paperheight\global\pdfpagewidth\paperwidth}}
% The idea hinted here is for LaTeX to generate markleft{} and markright{}
% automatically for you after you enter \author{}, \journal{},
% \journaldate{}, journalvol{}, \journalnum{}, etc.
% However, there may be some backward compatibility issues here as
% well as some special applications for IEEEtran.cls and special issues
% that may require the flexible \markleft{}, \markright{} and/or \markboth{}.
% We'll leave this as an open future suggestion.
%\newcommand{\journal}[1]{\def\@journal{#1}}
%\def\@journal{}
% pointsize values
% used with ifx to determine the document's normal size
\def\@IEEEptsizenine{9}
\def\@IEEEptsizeten{10}
\def\@IEEEptsizeeleven{11}
\def\@IEEEptsizetwelve{12}
% FONT DEFINITIONS (No sizexx.clo file needed)
% V1.6 revised font sizes, displayskip values and
% revised normalsize baselineskip to reduce underfull vbox problems
% on the 58pc = 696pt = 9.5in text height we want
% normalsize #lines/column baselineskip (aka leading)
% 9pt 63 11.0476pt (truncated down)
% 10pt 58 12pt (exact)
% 11pt 52 13.3846pt (truncated down)
% 12pt 50 13.92pt (exact)
%
% we need to store the nominal baselineskip for the given font size
% in case baselinestretch ever changes.
\newskip\@IEEEnormalsizefontbaselineskip
\@IEEEnormalsizefontbaselineskip\baselineskip
\ifx\@IEEEptsize\@IEEEptsizenine
\typeout{-- This is a 9 point document.}
\def\normalsize{\@setfontsize{\normalsize}{9}{11.0476pt}}%
\setlength{\@IEEEnormalsizefontbaselineskip}{11.0476pt}%
\normalsize
\abovedisplayskip 1.5ex plus3pt minus1pt%
\belowdisplayskip \abovedisplayskip%
\abovedisplayshortskip 0pt plus3pt%
\belowdisplayshortskip 1.5ex plus3pt minus1pt
\def\small{\@setfontsize{\small}{8.5}{10pt}}
\def\footnotesize{\@setfontsize{\footnotesize}{8}{9pt}}
\def\scriptsize{\@setfontsize{\scriptsize}{7}{8pt}}
\def\tiny{\@setfontsize{\tiny}{5}{6pt}}
% sublargesize is the same as large - 10pt
\def\sublargesize{\@setfontsize{\sublargesize}{10}{12pt}}
\def\large{\@setfontsize{\large}{10}{12pt}}
\def\Large{\@setfontsize{\Large}{12}{14pt}}
\def\LARGE{\@setfontsize{\LARGE}{14}{17pt}}
\def\huge{\@setfontsize{\huge}{17}{20pt}}
\def\Huge{\@setfontsize{\Huge}{20}{24pt}}
\fi
% Check if we have selected 10 points
\ifx\@IEEEptsize\@IEEEptsizeten
\typeout{-- This is a 10 point document.}
\def\normalsize{\@setfontsize{\normalsize}{10}{12.00pt}}%
\setlength{\@IEEEnormalsizefontbaselineskip}{12pt}%
\normalsize
\abovedisplayskip 1.5ex plus4pt minus2pt%
\belowdisplayskip \abovedisplayskip%
\abovedisplayshortskip 0pt plus4pt%
\belowdisplayshortskip 1.5ex plus4pt minus2pt
\def\small{\@setfontsize{\small}{9}{10pt}}
\def\footnotesize{\@setfontsize{\footnotesize}{8}{9pt}}
\def\scriptsize{\@setfontsize{\scriptsize}{7}{8pt}}
\def\tiny{\@setfontsize{\tiny}{5}{6pt}}
% sublargesize is a tad smaller than large - 11pt
\def\sublargesize{\@setfontsize{\sublargesize}{11}{13.4pt}}
\def\large{\@setfontsize{\large}{12}{14pt}}
\def\Large{\@setfontsize{\Large}{14}{17pt}}
\def\LARGE{\@setfontsize{\LARGE}{17}{20pt}}
\def\huge{\@setfontsize{\huge}{20}{24pt}}
\def\Huge{\@setfontsize{\Huge}{24}{28pt}}
\fi
% Check if we have selected 11 points
\ifx\@IEEEptsize\@IEEEptsizeeleven
\typeout{-- This is an 11 point document.}
\def\normalsize{\@setfontsize{\normalsize}{11}{13.3846pt}}%
\setlength{\@IEEEnormalsizefontbaselineskip}{13.3846pt}%
\normalsize
\abovedisplayskip 1.5ex plus5pt minus3pt%
\belowdisplayskip \abovedisplayskip%
\abovedisplayshortskip 0pt plus5pt%
\belowdisplayshortskip 1.5ex plus5pt minus3pt
\def\small{\@setfontsize{\small}{10}{12pt}}
\def\footnotesize{\@setfontsize{\footnotesize}{9}{10.5pt}}
\def\scriptsize{\@setfontsize{\scriptsize}{8}{9pt}}
\def\tiny{\@setfontsize{\tiny}{6}{7pt}}
% sublargesize is the same as large - 12pt
\def\sublargesize{\@setfontsize{\sublargesize}{12}{14pt}}
\def\large{\@setfontsize{\large}{12}{14pt}}
\def\Large{\@setfontsize{\Large}{14}{17pt}}
\def\LARGE{\@setfontsize{\LARGE}{17}{20pt}}
\def\huge{\@setfontsize{\huge}{20}{24pt}}
\def\Huge{\@setfontsize{\Huge}{24}{28pt}}
\fi
% Check if we have selected 12 points
\ifx\@IEEEptsize\@IEEEptsizetwelve
\typeout{-- This is a 12 point document.}
\def\normalsize{\@setfontsize{\normalsize}{12}{13.92pt}}%
\setlength{\@IEEEnormalsizefontbaselineskip}{13.92pt}%
\normalsize
\abovedisplayskip 1.5ex plus6pt minus4pt%
\belowdisplayskip \abovedisplayskip%
\abovedisplayshortskip 0pt plus6pt%
\belowdisplayshortskip 1.5ex plus6pt minus4pt
\def\small{\@setfontsize{\small}{10}{12pt}}
\def\footnotesize{\@setfontsize{\footnotesize}{9}{10.5pt}}
\def\scriptsize{\@setfontsize{\scriptsize}{8}{9pt}}
\def\tiny{\@setfontsize{\tiny}{6}{7pt}}
% sublargesize is the same as large - 14pt
\def\sublargesize{\@setfontsize{\sublargesize}{14}{17pt}}
\def\large{\@setfontsize{\large}{14}{17pt}}
\def\Large{\@setfontsize{\Large}{17}{20pt}}
\def\LARGE{\@setfontsize{\LARGE}{20}{24pt}}
\def\huge{\@setfontsize{\huge}{22}{26pt}}
\def\Huge{\@setfontsize{\Huge}{24}{28pt}}
\fi
% V1.6 The Computer Modern Fonts will issue a substitution warning for
% 24pt titles (24.88pt is used instead) increase the substitution
% tolerance to turn off this warning
\def\fontsubfuzz{.9pt}
% However, the default (and correct) Times font will scale exactly as needed.
% warn the user in case they forget to use the 9pt option with
% technote
\if@technote%
\ifx\@IEEEptsize\@IEEEptsizenine\else%
\typeout{** ATTENTION: Technotes are normally 9pt documents.}%
\fi%
\fi
% set \baselinestretch
\def\baselinestretch{1}
\if@draftclsmode% draft mode uses larger than normal spacing
\def\baselinestretch{1.5} % controls line spacing for draft version
\fi % some people may like 1.7 or greater
% so that there will be even more space
% for hand written comments
\normalsize % make \baselinestretch take affect
% V1.6
% store the normalsize baselineskip
\newskip\normalsizebaselineskip
\normalsizebaselineskip=\baselineskip\relax
% store the nominal value of jot
\newskip\normaljot
\normaljot=0.25\normalsizebaselineskip\relax
% set \jot
\jot=\normaljot\relax
% abstract and keywords are in \small, except
% for 9pt docs in which they are in \footnotesize
% Since 9pt docs use an 8pt footnotesize, \small
% becomes a rather awkward 8.5pt
\let\@IEEEabskeysecsize=\small
\ifx\@IEEEptsize\@IEEEptsizenine