IEEEtran HOWTO PDF

JOURNAL OF LATEX CLASS FILES, VOL. 14, NO.
8, AUGUST 2015 1
How to Use the IEEEtran LATEX Class

Michael Shell, Member, IEEE
(Invited Paper)
Abstract—This article describes how to use the IEEEtran class optional packages along with more complex usage techniques,
with LATEX to produce high quality typeset papers that are can be found in bare_adv.tex.
suitable for submission to the Institute of Electrical and
It is assumed that the reader has at least a basic working
Electronics Engineers (IEEE). IEEEtran can produce
conference, journal and technical note (correspondence) papers knowledge of LATEX. Those so lacking are strongly
with a suitable choice of class options. This document was encouraged to read some of the excellent literature on the
produced using IEEEtran in journal mode. subject [4]–[6]. In particular, Tobias Oetiker’s The Not So
Short Introduction to LATEX 2ε [5], which provides a general
Index Terms—Class, IEEEtran, LATEX, paper, style,
template, typesetting. overview of working with LATEX, and Stefan M. Moser’s
How to Typeset Equations in LATEX [6], which focuses on
the formatting of IEEE-style equations using IEEEtran’s
I. I NTRODUCTION
IEEEeqnarray commands, are both available for free online.
W ITH a recent IEEEtran class file, a computer running

LATEX, and a basic understanding of the LATEX language,
an author can produce professional quality typeset research
General support for LATEX related questions can be
obtained in the internet newsgroup comp.text.tex. There is also
a searchable list of frequently asked questions about LATEX
papers very quickly, inexpensively, and with minimal effort. [7].
The purpose of this article is to serve as a user guide of Please note that the appendices sections contain information
IEEEtran LATEX class and to document its unique features on installing the IEEEtran class file as well as tips on how to
and behavior. avoid commonly made mistakes.
This document applies to version 1.8b and later of
IEEEtran. Prior versions do not have all of the features
described here. IEEEtran will display the version number on II. C LASS O PTIONS
the user’s console when a document using it is being
compiled. The latest version of IEEEtran and its support files There are a number of class options that can be used to
can be obtained from IEEE’s web site [1], or CTAN [2]. This control the overall mode and behavior of IEEEtran. These are
latter site may have some additional material, such as beta test specified in the traditional LATEX way. For example,
versions and files related to non-IEEE uses of IEEEtran. See
the IEEEtran homepage \documentclass[9pt,technote]{IEEEtran}
[3] for frequently asked questions and recent news about
IEEEtran. is used with correspondence/brief/technote papers. The
various categories of options will now be discussed. For each
Complimentary to this document are the files 1 bare_con
category, the default option is shown in bold. The user must
f.tex, bare_jrnl.tex, bare_jrnl_comsoc.tex, bare_
specify an option from each category in which the default is
conf_compsoc.tex, bare_jrnl_compsoc.tex and
not the one desired. The various categories are totally
bare_ jrnl_transmag.tex, which are “bare bones”
orthogonal to each other—changes in one will not affect the
example (template) files of a conference, journal, IEEE
defaults in the others.
Communications Society journal, IEEE Computer Society
conference, IEEE Computer Society journal and IEEE
TRANSACTIONS ON M AGNETICS paper, respectively. Authors
can quickly obtain a functional document by using these files A. 9pt, 10pt, 11pt, 12pt
as starters for their own work. A more advanced example There are four possible values for the normal text size. 10pt
featuring the use of is used by the vast majority of papers. Notable exceptions are
Manuscript created February 25, 2002; revised August 26, 2015. This work technote papers, which use 9pt text and the initial submissions
was supported by the IEEE. This work is distributed under the LATEX to some conferences that use 11pt.
Project Public License (LPPL) ( http://www.latex-project.org/ ) version 1.3. A
copy of the LPPL, version 1.3, is included in the base LATEX Be aware that IEEE Computer Society publications use
documentation of all distributions of LATEX released 2003/12/01 or later. “PostScript” (i.e., “big point”, bp) point sizes (i.e., 72bp =
The opinions expressed here are entirely that of the author. No warranty is 1in) rather than the traditional typesetters’ point (i.e., 72.27pt
expressed or implied. User assumes all risk.
See http://www.michaelshell.org/ for current contact information. = 1in). Also, “10pt” IEEE Computer Society journal papers
1
Note that it is the convention of this document not to hyphenate command actually use a slightly smaller, 9.5bp, font size (probably to
or file names and to display them in typewriter font. Within such compensate for the slightly wider nature of the Palatino font).
constructs, spaces are not implied at a line break and will be explicitly carried
into the beginning of the next line. This behavior is not a feature of IEEEtran,
IEEEtran will automatically tweak the selected font size as
but is used here to illustrate computer commands verbatim. needed depending on the mode.
0000–0000/00$00.00 Qc 2015 Michael Shell
2 JOURNAL OF LATEX CLASS FILES, VOL. 14, NO. 8, AUGUST
B. draft, draftcls, draftclsnofoot, final

affiliations. Several commands are enabled to facilitate
IEEEtran provides for three draft modes as well as the this formatting (see Section IV-B2 for details).
normal final mode. The draft modes provide a larger (double) • The spacing after the authors’ names is reduced. So is
line spacing to allow for editing comments as well as one the spacing around the section names.
inch margins on all four sides of the paper. The standard draft • The special paper notice (if used) will appear between the
option puts every package used in the document into draft author names and the title (not after as with journals).
mode. With most graphics packages, this has the effect of • The figure captions are centered.
disabling the rendering of figures. If this is not desired, one • The following commands are intentionally disabled: \t
can use the draftcls option instead to yield a draft mode that hanks, \IEEEPARstart, \IEEEbiography, \IEEEb
will be confined within the IEEEtran class so that figures will iographynophoto, \IEEEpubid, \IEEEpubidadjco
be included as normal. draftclsnofoot is like draftcls, but does l, \IEEEmembership, and \IEEEaftertitletext. If
not display the word “DRAFT” along with the date at the needed, they can be reenabled by issuing the command:
foot of each page. Both draft and draftclsnofoot modes imply \IEEEoverridecommandlockouts.
draftcls (which is a subset of the other two). When using one • Various reminder (related to camera ready work) and
of the draft modes, most users will also want to select the warning notices are enabled.
onecolumn option. When using conference mode, most users will also want to
equalize the columns on the last page (see Section XIV).
C. conference, journal, technote, peerreview, peerreviewca
IEEEtran offers five major modes to encompass conference, D. comsoc, compsoc, transmag
journal, correspondence (brief/technote) and peer review pa-
These mutually exclusive options invoke special modes by
pers. Journal and technote modes will produce papers very
which IEEEtran produces the format of the publications of the
similar to those that appear in many IEEE T RANSACTIONS
IEEE Communications Society, IEEE Computer Society and
journals. When using technote, most users should also select
IEEE TRANSACTIONS ON MAGNETICS, respectively. Neither of
the 9pt option. The peerreview mode is much like the journal
these are enabled by default.
mode, but produces a single-column cover page (with the
1) Comsoc Mode: Comsoc mode only affects the math font
title, author names and abstract) to facilitate anonymous peer
so that it will more closely match the Times Roman main text.
review. The title is repeated (without the author names or
Either Michael Sharpe’s freely available newtxmath package
abstract) on the first page after the cover page. 2 Papers using
[8] (version 1.451, July 28, 2015 or later is recommended)
the peer review options require an \IEEEpeerreviewmaket
or the commercial MathTime [9] math fonts (as mtpro2.sty,
itle command (in addition to and after the traditional \make
mt11p.sty or mathtime.sty) are acceptable. Under comsoc
title) to be executed at the place the cover page is to end— mode, if one of these packages has not been loaded by the
usually just after the abstract. This command will be silently user at the start of the document, IEEEtran will attempt to
ignored with the non-peerreview modes. See the bare template enforce their use based on what is available on the system.
files for an example of the placement of this command. The The recommended loading procedure and order for newtx-
peerreviewca mode is like peerreview, but allows the author math is:
name information to be entered and formatted as is done
in conference mode (see Section IV-B2 for details) so that \usepackage[T1]{fontenc} % optional
author affiliation and contact information is more visible to \usepackage{amsmath}
\usepackage[cmintegrals]{newtxmath}
the editors. \usepackage{bm} % optional
1) Conference Mode Details: Conference mode makes a
number of significant changes to the way IEEEtran behaves: where the cmintegrals option, which IEEEtran sets as a default
upon loading newtxmath, is needed to obtain the specific style
• The margins are increased as the height of the text is
of integral symbol used by the IEEE Communications Society.
reduced to about 9.25in. In particular, the bottom margin
The optional bm package [10] provides for selective bold
will become larger than that of the top as the IEEE wants
math. Be aware that the AMS Math amssymb.sty package [11]
extra clearance at the bottom. The text height will not be
is not needed and should not be loaded as that functionality is
exactly 9.25in, but will vary slightly with the normal font
built into and provided by newtxmath as well as MathTime.
size to ensure an integer number of lines in a column.
Also, do not load the newtxtext.sty package as doing so would
• Headings and page numbers are not displayed in the
alter the main text font.
headers or footers. This, coupled with symmetric hori-
zontal margins, means that there will not be a noticeable a) Comsoc Conference Mode: Comsoc conference pa-
difference between the one and two sided options. pers are, at present, done the same way as traditional confer-
• The \author text is placed within a tabular ence papers (bare_conf.tex) and so no additional example
environment to allow for multicolumn formatting of file is required. Unless specifically instructed otherwise by
author names and the conference that is being submitting to, do not invoke the
comsoc option with conference papers.
2
A blank page may be inserted after the cover page when using the twoside 2) Compsoc Mode: Notable compsoc mode format features
(duplex printing) option so that the beginning of the paper does not appear include:
on the back side of the cover page.
SHELL: HOW TO USE THE IEEETRAN LATEX
3
• the default text font is changed from Times Roman margins will be the same and the text will be horizontally
to Palatino/Palladio (non-conference compsoc modes
centered.
only); For the compsoc conference and draft modes, it is the
• revised margins;
margins that will remain constant, and thus the text area size
• Arabic section numbering;
will vary, with changes in the paper size.
• enabling of the \IEEEcompsocitemizethanks and \I
The cspaper option is the special “trim” paper size (7.875in
EEEcompsocthanksitem commands to provide for the × 10.75in) used in the actual publication of IEEE Computer
\thanks (first footnote) itemized list used for author Society journals. Under compsoc journal mode, this option
affiliations; does not alter the typesetting of the document. Authors should
• enabling of the \IEEEtitleabstractindextext
invoke this option only if requested to do so by the editors of
command to provide for single column abstract and the specific journal they are submitting to.
index terms (see Section V); Note that authors should ensure that all post-processing
• various other styling changes (most of which are only
(PS, PDF, etc.) uses the same paper specification as the .tex
applicable under the non-conference compsoc modes) document. Problems here are by far the number one reason
such as the use of: a sans serif (Helvetica) font for titles, for incorrect margins. See Appendix B for more details.
headings, etc.; a ruled line above the first footnote area; For the special cspaper size, be aware that although IEEE-
left aligned reference labels; etc. tran will automatically configure the correct paper dimensions
a) Compsoc Conference Mode: IEEEtran follows the for pdfLATEX’s PDF mode (which it does for all paper
guidelines for IEEE Computer Society conference papers. sizes),
Perhaps surprisingly, this format nullifies many of the unique dvips (the application used for DVI to PS conversion) systems
features of compsoc journals and is not so much different will not recognize the special “ieeecs” paper unless there is
from traditional conference mode. However, Arabic section such an entry in dvips’ config.ps configuration file:
numbering is retained. It should be mentioned that Scott % Special paper size for the IEEE Computer Society J
Pakin’s IEEEconf LATEX class [12] also produces this ournals
format. Be aware that many IEEE Computer Society @ ieeecs 7.875in 10.75in
@+ ! %%DocumentPaperSizes: ieeecs
conferences use the traditional conference format and @+ %%BeginPaperSize: ieeecs
compsoc mode should not be used with them. @+ /setpagedevice where
3) Transmag Mode: For the transmag mode: @+ { pop << /PageSize [567 774] >> setpagedevice }
@+ if
• The text within \author should be entered as the long @+ %%EndPaperSize
form under conference mode; Most modern PS to PDF conversion software will correctly
• enabling of the \IEEEtitleabstractindextext handle such custom paper sizes if a different specific paper
command to provide for single column abstract and size is not explicitly requested for the conversion process.
index terms (see Section V);
• \IEEEauthorrefmark will produce arabic author affil-
iation symbols; F. oneside, twoside
• subsection and subsubsection headings and/or their spac- These options control whether the layout follows that of
ings are slightly different; single sided or two sided (duplex) printing. Because the side
• a smaller, bold font than normal is used for the title. margins are normally centered, the main notable difference is
The transmag mode (as well as the standard journal mode) in the format of the running headings.
is also acceptable for submission to IEEE Magnetics Letters.
Authors who wish to have their figures and tables appear at G. onecolumn, twocolumn
the end of the paper can use the endfloat.sty [13] package to These options allow the user to select between one and
achieve this. two column text formatting. Since the IEEE always uses two
column text, the onecolumn option is of interest only with
draft papers.
E. letterpaper, a4paper, cspaper
IEEEtran fully supports both the US letter (8.5in × 11in)
H. romanappendices
and A4 (210mm ×297mm) paper sizes. Since the IEEE
primarily uses US letter, authors should usually select the IEEEtran defaults to numbering appendices alphabetically
letterpaper option before submitting their work to the IEEE— (e.g., A, B, etc.). Invoke this option to get Roman numbering.
unless told otherwise (typically by conferences held outside
the United States). Changing the paper size in the standard I. captionsoff
journal and conference modes will not alter the typesetting of Invoking this option will inhibit the display of captions
the document—only the margins will be affected. In within figures and tables. This is done in a manner that
particular, documents using the a4paper option will have preserves the operation of \label within \caption. This
reduced side margins (A4 is narrower than US letter) and a option is intended for journals, such as IEEE T RANSACTIONS
longer bottom margin (A4 is longer than US letter). For both ON POWER ELECTRONICS (TPE), that require figures and tables
cases, the top to placed, captionless, on pages of their own at the
end of the document. Such figure placement can be achieved

\newcommand{\CLASSINPUTinnersidemargin}{17mm}
with the help of the endfloat.sty package [13]: \documentclass{IEEEtran}
\usepackage[nomarkers]{endfloat}
will yield a document that has 17mm side margins—if only
Note that the TPE has other unusual formatting requirements one of the innerside/outerside (or toptext/bottomtext) margin
that also require the draftclassnofoot and onecolumn options pair is specified, IEEEtran will assume the user wants sym-
as well as the insertion of page breaks (\newpage) just prior metric side (or top/bottom) margins and will set both values
to the first section as well as the bibliography. Such of the relavant pair to the (single) user specified value.
commands can be enabled conditionally via the \ IEEEtran uses the fixed values of 12pt and 0.25in for \h
ifCLASSOPTIONcapt ionsoff conditional (Section III-A). eadheight and \headsep , respectively. The position of
the header can be altered after IEEEtran is loaded, without
changing the margins as long as the sum of \topmargin,
J. nofonttune
\headheight and \headsep is preserved. For example, the
IEEEtran normally alters the default interword spacing to header can be shifted upwards 0.2in using:
be like that used in IEEE publications. The result is text that
\addtolength{\headsep}{0.2in}
requires less hyphenation and generally looks more pleasant, \addtolength{\topmargin}{-0.2in}
especially for two column text. The nofonttune option will
disable the adjustment of these font parameters. This option Likewise, \footskip, which has a default value of 0.4in, can
should be of interest only to those who are using fonts easily be changed to alter the position of the footer within the
specifically designed or modified for use with two column bottom margin.
work. When using \CLASSINPUTbaselinestretch, IEEEtran
will automatically “digitize” \textheight so that an integer
number of lines will fit on a page (as is done in the draft
III. T HE CLASSINPUT, CLASSOPTION AND
modes). Digitization is not done when the top or bottom
CLASSINFO CONTROLS
margins are set via CLASSINPUTs. Users are cautioned that
IEEEtran offers three catagories of special commands that using CLASSINPUT controls can result in documents that
allow information to be passed between the class file and the are not compliant with the IEEE’s standards. The intended
user’s document: applications include: (1) conferences or societies that have
• CLASSINPUTs are inputs that provide a way to cus- unusual formatting requirements; (2) producing copies with
tomize the operation of IEEEtran by overriding some of nonstandard margins such as when binding for personal use;
the default settings (at the time IEEEtran is loaded); and (3) non-IEEE related work.
• CLASSOPTIONs which are outputs that allow for condi-
tional compilation based on which IEEEtran class options B. CLASSOPTIONs
have been selected;
• CLASSINFOs which are outputs that allow the user a CLASSOPTIONs are primarily TEX \if conditionals that
way to access additional information about the IEEEtran are automatically set based on which IEEEtran options are
runtime environment. being used. Thus, for example, a construct such as
\ifCLASSOPTIONconference
\typeout{in conference mode}
A. CLASSINPUTs \else
\typeout{not in conference mode}
The available CLASSINPUTs include: \CLASSINPUTbase \fi
linestretch which sets the line spacing of the
document; can be used to provide for conditional code execution. Please
\CLASSINPUTinnersidemargin which sets the margin at note that, as mentioned in Section II-B, the draft and draft-
the inner (binding) edge; \CLASSINPUToutersidemargin clsnofoot options imply draftcls. So, most users will want to
which sets the margin at the outer edge; \CLASSINPUTtopt test \ifCLASSOPTIONdraftcls for detecting the draft
extmargin which sets the top margin; \CLASSINPUTbotto modes.
mtextmargin which sets the bottom margin. Of course, such For the document’s point size options, \CLASSOPTIONp
parameters can be set via the traditional LATEX interface (\ t is defined as a macro that expands to the numerical part
odd sidemargin, \topmargin, etc.). However, the of the selected point value (e.g., 9, 10, 11 or 12). For the
advantage of paper size options, \CLASSOPTIONpaper will be a macro
of using the CLASSINPUT approach is that it allows that contains the paper specification (e.g., letter, a4). To use
IEEEtran to adjust other internal parameters and perform any these as conditionals will require a string macro comparison:
additional calculations as needed. For example, setting the \newcommand{\myninestring}{9}
side margins \ifx\CLASSOPTIONpt\myninestring
\typeout{document is 9pt}
in LATEX requires a careful setting of \oddsidemargin, \fi
\e vensidemargin and \textwidth taking into
consideration the paper size and whether or not duplex (two- Users should treat the CLASSOPTIONs as being “read-only”
sided) printing is being used. and not attempt to manually alter their values because IEEE-
To invoke a CLASSINPUT, just define the relavant tran uses them internally as flags to determine which options
CLASS- INPUT as desired prior to the loading of IEEEtran.
For example,
5
have been selected—changing these flags will likely result in The \thanks command produces the “first footnotes.” Be-
improper formatting. cause the LATEX \thanks was not designed to contain
multiple paragraphs3, authors will have to use a separate \
C. CLASSINFOs thanks for each paragraph. However, if needed, regular line
The available CLASSINFOs include the \ifCLASSINFOp breaks (\\) can be used within \thanks. In order to get
df conditional which works much like Heiko Oberdiek’s if- proper line breaks and spacing, it is important to correctly use
pdf.sty package [14] to indicate if PDF output (from and control the spaces within \author. Use nonbreaking
pdfLATEX) is in effect: spaces (˜ ) to ensure that name/membership pairs remain
\ifCLASSINFOpdf
together. A minor, but easy, mistake to make is to forget to
\typeout{PDF mode} prevent unwanted spaces from getting between commands
\fi which use delimited ({}) arguments. Note the two % which
IEEEtran.cls also provides the lengths \CLASSINFOnorma serve to prevent the code line break on lines ending in a }
lsizebaselineskip, which is the \baselineskip of the from becoming an unwanted space. Such a space would not be
normalsize font, and \ ignored as an end-of-line space because, technically, the last \
CLASSINFOnormalsizeunitybaseli neskip, which is thanks is the final command on the line. “Phantom” spaces
the \baselineskip of the normalsize font under unity \ like these would append to the end of the last author’s name,
baselinestetch. causing the otherwise centered name line to shift very slightly
Finally, there are the string macros (these are not condition- to the left.
als or lengths) \CLASSINFOpaperwidth and \ 2) Names in Conference Mode: The author name area
CLASSINF Opaperheight which contain the paper is more complex when in conference mode because it also
contains the authors’ affiliations. For this reason, when in
dimensions in their native specifications including units (e.g.,
conference mode, the contents of \author{} are placed
8.5in, 22mm, etc.). As with CLASSOPTIONs, users should
not attempt to alter the CLASSINFOs. into a modified tabular environment. The commands \IE
EEauthorblockN{} and \IEEEauthorblockA{} are also
IV. T HE T ITLE PAGE provided so that it is easy to correctly format the author names
and affiliations, respectively. For papers with three or less
The parts of the document unique to the title area are affiliations, a multicolumn format is preferred:
created using the standard LATEX command \maketitle.
\author{\IEEEauthorblockN{Michael Shell}
Before this command is called, the author must declared all of \IEEEauthorblockA{School of Electrical and\\
the text objects which are to appear in the title area. Computer Engineering\\
Georgia Institute of Technology\\
Atlanta, Georgia 30332--0250\\
A. Paper Title Email: mshell@ece.gatech.edu}
\and
The paper title is declared like: \IEEEauthorblockN{Homer Simpson}
\title{A Heuristic Coconut-based Algorithm} \IEEEauthorblockA{Twentieth Century Fox\\
Springfield, USA\\
in the standard LATEX manner. Titles are generally Email: homer@thesimpsons.com}
\and
capitalized except for words such as a, an, and, as, at, but, by, \IEEEauthorblockN{James Kirk\\
for, in, nor, of, on, or, the, to and up, which are usually not and Montgomery Scott}
capitalized unless they are the first or last word of the title. \IEEEauthorblockA{Starfleet Academy\\
San Francisco, California 96678-2391\\
Line breaks (\\) may be used to equalize the length of the title Telephone: (800) 555--1212\\
lines. Do not use math or other special symbols in the title. Fax: (888) 555--1212}}
Use \and to separate the affiliation columns. The columns

B. Author Names will automatically be centered with respect to each other and
The name and associated information is declared with the the side margins.
\author command. \author behaves slightly differently If there are more than three authors and/or the text is too
depending on the document mode. wide to fit across the page, use an alternate long format:
1) Names in Journal/Technote Mode: A typical \author \author{\IEEEauthorblockN{Michael Shell\IEEEauthorre
command for a journal or technote paper looks something like fmark{1}, Homer Simpson\IEEEauthorrefmark{2}, James
this: K irk\IEEEauthorrefmark{3}, Montgomery Scott\
IEEEautho rrefmark{3} and Eldon Tyrell\
\author{MichaelS̃hell,˜
\IEEEmembership{Member,ĨEEE, IEEEauthorrefmark{4}}
} JohnD̃oe,˜
\IEEEmembership{Fellow,ÕSA,} andJ̃aneD̃ oe,˜
\ \IEEEauthorblockA{\IEEEauthorrefmark{1}School of Ele
IEEEmembership{LifeF̃ellow,ĨEEE}% ctrical and Computer Engineering\\
\thanks{Manuscript received January 20, 2002; revise Georgia Institute of Technology, Atlanta, Georgia 30
d August 26, 2015. This work was supported by the IE 332--0250\\
EE.}% Email: mshell@ece.gatech.edu}
\thanks{M. Shell was with the Georgia Institute of T \IEEEauthorblockA{\IEEEauthorrefmark{2}Twentieth Cen
echnology.}} tury Fox, Springfield, USA\\
Email: homer@thesimpsons.com}
The \IEEEmembership command is used to produce the
italic font that indicates the authors’ IEEE membership status. 3
Although IEEEtran.cls does support it, the standard classes do not.
\IEEEauthorblockA{\IEEEauthorrefmark{3}Starfleet Aca Note that because the text in the running headings is automat-
demy, San Francisco, California 96678-2391\\ ically capitalized, the \MakeLowercase{} command must
Telephone: (800) 555--1212, Fax: (888) 555--1212}
\IEEEauthorblockA{\IEEEauthorrefmark{4}Tyrell Inc., be used to obtain lower case text. The second argument is used
123 Replicant Street, Los Angeles, California 90210 as a page heading only for the odd number pages after the
--4321}} title page for two sided (duplex) journal papers. This page is
The \IEEEauthorrefmark{} command will generate a such an example. Technote papers do not utilize the second
footnote symbol corresponding to the number in its argument. Conference papers do not have running headings,
argument. Use this to link the author names to their respective so \markboth{}{} has no effect when in conference mode.
affiliations. It is not necessary prevent spaces from being Authors should not put any name information in the headings
between the \IEEEa uthorblock’s because each block (if used) of anonymous peer review papers.
starts a new group of lines and LATEX will ignore spaces at
the very end and beginning of lines. D. Publication ID Marks
3) Names in Compsoc Journal Mode: One unique feature
Publication ID marks can be placed on the title page of
of IEEE Computer Society journals is that author affiliations
journal and technote papers via the \IEEEpubid{}
are formatted in an itemized list within the first ( \thanks)
command:
footnote. In compsoc mode, IEEEtran provides a special form
of \thanks, \IEEEcompsocitemizethanks, to obtain this \IEEEpubid{0000--0000/00\$00.00˜
\copyright2̃015 IEEE
}
effect:
\author{MichaelS̃hell,˜
\IEEEmembership{Member,ĨEEE, Although authors do not yet have a valid publication ID at the
} JohnD̃oe,˜
\IEEEmembership{Fellow,ÕSA,} andJ̃aneD̃ oe,˜
\ time of paper submission, \IEEEpubid{} is useful because
IEEEmembership{LifeF̃ellow,ĨEEE}%
\IEEEcompsocitemizethanks{\IEEEcompsocthanksitem M. it provides a means to see how much of the title page text area
Shell is with the Georgia Institute of Technology. will be unavailable in the final publication. This is especially
\IEEEcompsocthanksitem J. Doe and J. Doe are with An important in technote papers because, in some journals, the
onymous University.}%
\thanks{Manuscript received January 20, 2002; revise
publication ID space can consume more than one text line. If
d August 26, 2015.}} \IEEEpubid{} is used, a second command, \IEEEpubidad
jcol must be issued somewhere in the second column of the
Within \IEEEcompsocitemizethanks, \IEEEcompsoctha title page. This is needed because LATEX resets the text
nksitem works like \item to provide a bulleted affiliation
height at the beginning of each column. \IEEEpubidadjcol
group. To facilitate dual compilation, in non-compsoc mode, “pulls up” the text in the second column to prevent it from
IEEEtran treats \IEEEcompsocitemizethanks as \ blindly
thanks and sets \IEEEcompsocthanksitem to generate a running into the publication ID.
line break with indentation. However, this is not entirely Publication IDs are not to be placed by the author on
satisfactory as IEEE Computer Society journals place the camera ready conference papers so \IEEEpubid{} is
author affiliations before the “manuscript received” line while disabled in conference mode. Instead the bottom margin is
traditional IEEE journals use the reverse order. If correct dual automatically increased by IEEEtran when in conference mode
compilation is needed, the CLASSOPTION conditionals can
to give the IEEE room for such marks at the time of
be employed to swap the order as needed.
publication. In draft mode, the publisher ID mark will not be
4) Names in Compsoc Conference Mode: Names in comp-
printed at the bottom of the titlepage, but room will be
soc conference mode are done in the same way as traditional
cleared for it.
conference mode.
Publication ID marks are perhaps less important with comp-
5) Names in Transmag Journal Mode: IEEE T RANSAC -
soc papers because IEEE Computer Society journals place the
TIONS ON M AGNETICS papers typically use the conference
publisher ID marks within the bottom margin so as not to
long format for author names, but try to keep each name and
affect the amount of page space available for text.
address pair on one line and without any email addresses or
phone numbers. Also, \thanks is available under transmag
journal mode even though the names are entered much like E. Special Paper Notices
the long format under conference mode. See the file bare_ Special paper notices, such as for invited papers, can be
jrnl_transmag.tex for an example of author entry under declared with:
transmag mode.
\IEEEspecialpapernotice{(Invited Paper)}
C. Running Headings Special paper notices in journal and technote papers appear
The running headings are declared with the \markboth{ between the author names and the main text. The title page
}{} command. The first argument contains the journal name of this document has an example. For conference papers, the
information and the second contains the author name and special paper notice is placed between the title and the author
paper title. For example: names.
Much more rarely, there is sometimes a need to gain access
\markboth{Journal of Quantum Telecommunications,Ṽol
.1̃, No.1̃,J̃anuary2̃025}{Shell \MakeLowercase{\text to the space across both columns just above the main text.
it{et al.}}: A Novel Tin Can Link} For instance, a paper may have a dedication [15]. IEEEtran
provides the command \IEEEaftertitletext{} which
can be used to insert text or to alter the spacing between the
title area and the main text: 7
\IEEEaftertitletext{\vspace{-1\baselineskip}} To facilitate dual compilation, IEEEtran provides another

command, \IEEEdisplaynontitleabstractindextext,
Authors should be aware that IEEEtran carefully calculates
which will “become” whatever was declared in \IEEEtitl
the spacing between the title area and main text to ensure that
eabstractindextext when in non-compsoc, non-transmag
the main text height of the first page always is equal to an
or conference mode (as compsoc conferences use the same
integer number of normal sized lines (unless the top or bottom
placement for the abstract and index terms as traditional
margins have been overridden by CLASSINPUTs). Failure to
conferences do). That is to say, the abstract and index terms
do this can result in underfull vbox errors and paragraphs sections can be automatically “teleported’ to the appropriate
being “pulled apart” in the second column of the first page place they need to be depending on the document mode. \IE
if there isn’t any rubber lengths (such as those around section EEdisplaynontitleabstractindextext should
headings) in that column. The contents of \IEEEaftertitle
typically be placed just after \maketitle (and before \
text{} are intentionally allowed to bypass this “dynamically
IEEEpeerre viewmaketitle if used).
determined title spacing” mechanism, so authors may have to
manually tweak the height (by a few points) of the \IEEEa
ftertitletext{} contents (if used) to avoid an underfull VI. S ECTIONS
vbox warning.
Sections and their headings are declared in the usual
V. A BSTRACT AND I NDEX T ERMS LATEX fashion via \section, \subsection, \
The abstract is generally the first part of a paper after \m subsubsection, and \paragraph. In the non-compsoc
aketitle. The abstract text is placed within the abstract modes, the numbering for these sections is in upper case
environment: Roman numerals, upper case letters, Arabic numerals and
lower case letters, respectively. In compsoc mode, Arabic
\begin{abstract}
We propose ... numerals are used exclusively for (sub)section numbering.
\end{abstract} The \paragraph section is not allowed for technotes or
Math, special symbols and/or citations should generally not compsoc conferences as these generally are not permitted to
have such a deep section nesting depth. If needed, \paragra
be used in abstracts.4
ph can be restored by issuing the command \
Journal and technote papers also have a list of key words
setcounter{ secnumdepth}{4} in the document
(index terms) which can be declared with:
preamble.
\begin{IEEEkeywords} Note that IEEE Computer Society journals (but not con-
Broad band networks, quality of service, WDM.
\end{IEEEkeywords} ferences!) are unusual in that they raise the very first section
(the introduction) heading above the start of the text. IEEEtran
To obtain a list of valid keywords from the IEEE, just send a provides a command to produce this effect:
blank email to keywords@ieee.org. A list of IEEE Computer
Society approved keywords can be obtained at http://www. \IEEEraisesectionheading{\section{Introduction}\labe
computer.org/mc/keywords/keywords.htm. Do not use math l{sec:introduction}}
or special symbols in the keywords.
The IEEE Computer Society and IEEE TRANSACTIONS ON This command is not intended for any use other than the
MAGNETICS formats present a difficulty in that compsoc and introduction section in compsoc journal mode. Note the need
transmag journal (but not compsoc conference) papers place to keep any \label that is to refer to the section immediately
the abstract and index terms sections in single column format after \section in the above as \IEEEraisesectionheadi
just below the author names, but the other IEEE formats place ng puts \section within a raised box.
them in the first column of the main text before the first
section. To handle this, IEEEtran offers a command, \IEEEt
itleabstractindextext, that is to be declared before \ma A. Initial Drop Cap Letter
ketitle, and whose single argument holds the text/sections
The first letter of a journal paper is a large, capital,
that are to appear in single column format after the author
oversized letter which descends one line below the baseline.
names:
Such a letter is called a “drop cap” letter. The other letters in
\IEEEtitleabstractindextext{% the first word are rendered in upper case. This effect can be
\begin{abstract}
We propose ... accurately produced using the IEEEtran command \
\end{abstract} IEEEPARstart{}{
\begin{IEEEkeywords} }. The first argument is the first letter of the first word, the
Broad band networks, quality of service, WDM. second argument contains the remaining letters of the first
\end{IEEEkeywords}}
word. The drop cap of this document was produced with:
4
That said, if it is permitted or required, be aware that in order to preserve
the distinction between constructs such as vector and scalar forms, IEEEtran \IEEEPARstart{W}{ith}
defaults to using non-bold math within the abstract. However, bold math
better matches the bold text font used for the abstract text. If a bold math font
is desired, just issue a \boldmath command at the start of the abstract. Note that some journals will also render the second word in
upper case—especially if the first word is very short. For more
usage examples, see the bare_jrnl.tex example file.
9
VII. CITATIONS IEEE publications do not typically use the word “equation,”
Citations are made with the \cite command as usual. but rather just enclose the equation number in parentheses,
IEEEtran will produce citation numbers that are individually e.g.,
bracketed in IEEE style. (“[1], [5]” as opposed to the more
common “[1, 5]” form.) The base IEEEtran does not sort or ... as can be seen in (\ref{eqn_example}).
produce compressed “ranges” when there are three or more
IEEE’s two column format puts serious constraints on how
adjacent citation numbers. However, IEEEtran pre-defines
wide an equation can be. So, a fair portion of the effort in
some format control macros to facilitate easy use with Donald
formatting equations usually has to be devoted to properly
Arseneau’s cite.sty package [16]. So, all an author has to do
breaking them. It is the author’s responsibility to ensure
is to call cite.sty:
that all equations fit into the given column width. In rare
\usepackage{cite} circumstances, it is possible to have a few equations that span
and the adjacent citation numbers will automatically be sorted both columns (see Section X-D1), but the vast majority of
and compressed (ranged) IEEE style. (Of course, multiple over-length equations have to be broken across multiple lines.
adjacent citations should always all be declared within a
single \cite, comma separated, for this to work.) Invoke
IX. M ULTI -LINE EQUATIONS
cite.sty’s noadjust option to prevent an unwanted leading
space from occurring should a citation ever need to be Perhaps the most convenient and popular way to produce
enclosed in parenthesis. multiline equations is LATEX 2ε ’s eqnarray environment.
One complication in compsoc mode is that the IEEE However, eqnarray has several serious shortcomings:
Computer Society does not compress, but does sort, adjacent 1) the use of 2×\arraycolsep for a column separation
citation numbers. Version 4.0 and later of cite.sty provides a
space does not provide natural math spacing in the
nocompress option that disables compression, but preserves default configuration;
sorting. Thus, 2) column definitions cannot be altered;
\ifCLASSOPTIONcompsoc 3) it is limited to three alignment columns;
% requires cite.sty v4.0 or later (November 2003)
\usepackage[nocompress]{cite}
4) column alignment cannot be overridden within individ-
\else ual cells.
\usepackage{cite}
\fi
There are a number of vastly superior packages for format-
ting multiline mathematics. Perhaps the most popular is the
can be used with universal applicability. amsmath package [11]. Amsmath is a comprehensive work
Note that, if needed (e.g., next to a non-punctuation, non- which contains many helpful tools besides enhanced multiline
space character), cite.sty’s \cite command will alignment environments. So, all authors should give serious
automatically add a leading space. i.e., “( \ consideration to its use—regardless of what they use to gen-
cite{mshell01})” will become like “( [1])”. If this behavior erate aligned equations. One thing to be aware of is that, upon
is not desired, use the cite package’s noadjust option (cite.sty loading, amsmath will configure LATEX to disallow page
V3.8 and later) which will turn off the added spaces: breaks within multiline equations (even within non-amsmath
\usepackage[noadjust]{cite} defined environments). The philosophy here is that author
should manually insert breaks where desired so as to ensure
\cite also allows for an optional note (e.g., \cite[Th. that breaks occur only at acceptable points. To restore
7.1]{mshell01}). If the \cite with note has more than IEEEtran’s ability to automatically break within multiline
one reference, the note will be applied to the last of the listed equations, load amsmath like:
references. It is generally desirable that if a note is given, only
one reference should be listed in that \cite. \usepackage{amsmath}
\interdisplaylinepenalty=2500
VIII. E QUATIONS Another extremely powerful set of alignment tools, one

Equations are created using the traditional equation envi- of which is a totally rewritten eqnarray environment, is
ronment: provided by mathenv.sty which is part of Mark Wooding’s
\begin{equation} MDW Tools [17].
\label{eqn_example} Finally, IEEEtran provides a fully integrated custom IEEEe-
x = \sum\limits_{i=0}^{z} 2^{i}Q qnarray family of commands (see Appendix F) that are de-
\end{equation}
signed to have almost universal applicability for many
which yields different types of alignment situations.
z
Nevertheless, it is instructive to show a simple example
x= 2iQ. (1) using the standard eqnarray in order to explain some of the
i=0
fine points of math spacing under LATEX. As shown in
Use the displaymath environment instead if no equation Table I, TEX normally draws from four different spacings
number is desired. When referring to equations, articles in when typesetting mathematics. In order to produce precise
(and
TABLE I
M ATH S PACINGS U SED BY LATEX empty ord to the left side of the plus sign (line three) does
engage binary spacing, but causes an unwanted 7 right shift
Size Width Cmd. Used for Example of the line. Finally, manually adding a medium space to the
small 1/6 em \, symbols ab right side only of the plus sign in line four does the trick. The
medium 2/9 em \: binary operators a+b suppression of automatic spacing around the plus sign ({+})
large 5/18 em \; relational operators a=b is unneeded in this case, but may be required in other
negative small −1/6 em \! misc. uses ab
alignment environments that “expand” such operators by
default.
correct) mathematical alignments, it is crucial to understand Another way around the spacing problem is to use only
two alignment columns (as is done by amsmath.sty’s \alig
how to control such spacing. Consider a multiline equation
n). e.g., in the previous example, “Z =” would be contained in
Z = x1 + x2 + x3 + x4 + x5 + x6 the first column.
+a + b (1)
+a + b (2) A. Cases Structures
+a+b (3) Incidentally, the numcases (or subnumcases) environ-
+a+b (4) ments in Donald Arseneau’s cases.sty package [18] should be
used when “cases” structures in which each branch can be
(in typical IEEE style) which was produced by referenced with a different equation (or subequation) number
\setlength{\arraycolsep}{0.0em} are needed:
\begin{eqnarray}
Z&{}={}&x_1 + x_2 + x_3 + x_4 + x_5 + x_6\nonumber\\ x, for x ≥ 0 (5a)
&&+a + b\\ x| =| −x, for x < 0 (5b)
&&+{}a + b\\
&&{}+a + b\\ because those built from the array or amsmath cases
&&{+}\:a + environments will have a single equation number that
b
\end{eqnarray} encompasses both branches.
\setlength{\arraycolsep}{5pt} Be aware that if amsmath (which will be automatically
loaded under comsoc mode if the user did not do so) is to
Lines one through four show some possible ways the + a + b
be used with cases.sty, the latter should be loaded after the
line could be implemented.5 Only number four is the correct
former or else an error “Command \subequations alr
way for most IEEE purposes. In TEX’s math mode, spacing
eady defined” may occur.
around operators can be inhibited by enclosing them within
braces (e.g., {=}) or forced by surrounding them with “empty
ords” (e.g., {}={}). It is important to understand that the X. FLOATING S TRUCTURES
empty ords do not have width themselves. However, their Authors should keep in mind when choosing an appropriate
presence causes TEX to place space around the operators as if optional placement argument for the figure/table environments
they were “next to something.” With this in mind, the first that most IEEE journals strongly favor the positioning of
step in the example is to set \arraycolsep to zero to floats to the top of the page and rarely, if ever, use bottom
prevent eq narray from putting in the unwanted, artificial, floats. IEEE Computer Society journals also favor top floats,
inter-column spacing. Placing empty ords around the equal but do occasionally employ bottom floats. Furthermore, IEEE
sign then forces the correct natural spacing. Alternatively, \ journals never place floats in the first column of the first page
arraycolsep could have been set to 0.14 em and the and rarely (if ever) do they do so in the second column of
empty ords around the equal sign eliminated.6 It is important the first page. Middle in-text placement (“here”) is usually
to remember to restore not used for IEEE work with one notable exception—IEEE
\arraycolsep to its default value of 5 pt after the Computer Society conferences.
eqnarr ay is complete as other environments (such as Note that LATEX 2ε ’s float routine places footnotes
array) depend on it. (Alternatively, the structure could have above bottom floats. To change this so that footnotes appear
been enclosed in a group of braces to keep the change local— below the bottom floats (as the IEEE does) invoke the \
which has the added advantage of not requiring that the user fnbelowflo at command provided by Sigitas Tolušis’
remember what the correct default value is.) stfloats package [19] (see Section X-D for more features of
The first line is incorrect because a is being indicated as the stfloats package).
a positive quantity rather than something that must be added
to the previous line. (i.e., the + is being treated as a unary, A. Figures
rather than a binary, operator.) In line two, adding an empty
ord to the right side of the plus sign does nothing, except Figures handled in the standard LATEX manner. For example:
to demonstrate that empty ords have zero width. Adding an \begin{figure}[!t]
\centering
5 \includegraphics[width=2.5in]{myfigure}
In this example, the equation numbering system is (ab)used to identify
lines. \caption{Simulation results for the network.}
6
This assumes that 1 em in the text font has the same width as 1 em in the
7
math font. For the standard fonts, this is indeed the case. The IEEE normally wants all of the lines left aligned, but there are cases
when such an indention may be desirable.
1
\label{fig_sim} It is important to note that subfig.sty package options are

\end{figure} usually required to obtain IEEE compliant subfigure captions.
Furthermore, compsoc format requires a larger sans serif font
Note that (1) figures should be centered via the LATEX \cent
than the serif footnote size font used in traditional IEEE for-
ering command—this is a better approach than using the ce
matting. There is a further complication with subfig.sty in that
nter environment which adds unwanted vertical spacing; (2)
the caption follows the graphic; and (3) any labels must be this package depends on caption.sty, which, in its default con-
declared after (or within) the caption command. figuration, will overrride IEEEtran’s handling of captions—
When referring to figures in typical IEEE papers, authors resulting in non-IEEE style main captions. To prevent this,
should use the abbreviation “Fig.”, but in IEEE Computer be sure to invoke subfig.sty’s caption=false option, which
Society conference papers they should use the full word has been available since version 1.3 (2005/06/28). Thus, the
“Figure”. IEEEtran provides the string macro \figurename recommended way to load subfig.sty is:
which contains the correct name to use for the given \ifCLASSOPTIONcompsoc
\usepackage[caption=false,font=normalsize,labelfon
formatting mode. t=sf,textfont=sf]{subfig}
The \includegraphics command is the modern, pre- \else
ferred, way of including images and provides a flexible in- \usepackage[caption=false,font=footnotesize]{subfi
g}
terface that makes it easy to scale graphics to size. To use it, \fi
the graphics or graphicx (the latter is recommended) must first
be loaded. Because multiple subfigures usually require more width
It is strongly recommended that authors be familiar with the than is available in a single column, they are often used within
graphics package documentation [20] as well as Keith Reck- the double column figure environment (Section X-D):
dahl’s excellent Using Imported Graphics in LATEX 2ε [21]. \begin{figure*}[!t]
The reader is reminded that the “draftcls” or “draftclsnofoot”, \centering
\subfloat[Case I]{\includegraphics[width=2.5in]{subf
not “draft”, class option must be selected in order to get draft igcase1}
papers with visible figures. \label{fig_first_case}}
As explained in Appendix D, Encapsulated PostScript \hfil
\subfloat[Case II]{\includegraphics[width=2.5in]{sub
(EPS) or Portable Document Format (PDF) is the preferred figcase2}
graphics format for LATEX work. Furthermore, the \label{fig_second_case}}
user’s drawing/graphing application should be capable of \caption{Simulation results for the network.}
\label{fig_sim}
outputing directly in EPS (or PDF) vector form (which will \end{figure*}
not degrade or pixelize when magnified)—although photos
will likely have to be in (EPS/PDF/JPEG/PNG) bitmap form. Note how captions can be tagged to each of the subfigures as
Be aware that the use of pdfLATEX is required for image well as to the overall figure via an optional argument to the \s
formats other than EPS. ubfloat command. However, most IEEE authors/journals do
The psfrag package [22] might also be of interest. Psfrag not employ subfigure captions, but instead reference/describe
allows the user to “go into” an EPS graphic and replace text all of the subfigures (a), (b), etc., within the main caption. Be
strings contained in it with real LATEX code. In this aware that for subfig.sty to generate the (a), (b), etc., subfigure
manner, LATEX’s extensive support of mathematical labels the optional argument to \subfloat must be present.
symbols and fonts can be extended to figures made with If a subcaption is not desired, just leave its contents blank
applications with more modest glyph support. Using psfrag (e.g., \subfloat[]). \hfil is used as a subfigure separator
does require the use of the dvips DVI to PostScript to achieve equal spacing around the graphics. More complex
conversion step (not pdfLATEX’s PDF mode) as some of the implementations are possible. Note that the total width of all
features of the PostScript language have to be utilized.8 the subfigures on a line must be less than the text width or else
pdfLATEX users can use psfrag by “preprocess- ing” their an unwanted line break will occur. Multiple lines of
figures by importing them into a dummy document using subfigures can be used within a figure if needed. See the
psfrag, running LATEX followed by dvips, then converting the subfig.sty documentation as well as the Using Imported
PostScript output to a PDF graphic for direct importation into Graphics in LATEX 2ε guide [21] for more details.
the main document which is then processed by pdfLATEX. Axel Sommerfeldt’s modern and actively maintained sub-
There is additional usage information on psfrag in the Using caption.sty package [25] can not be recommended at this time
Imported Graphics in LATEX 2ε guide [21]. because it does not provide an option to prevent the
1) Subfigures: Subfigures can be obtain via the use of underlying caption.sty from taking control of main caption
Steven Douglas Cochran’s subfigure [23] or subfig [24] pack- formatting away from IEEEtran.
ages. Be forewarned that the former is no longer being
maintained and, although self-contained and compatible with B. Algorithms
IEEEtran, is becoming incompatible with an increasing num-
IEEE publications use the figure environment to contain
ber of other LATEX packages including fixltx2e.sty. For
algorithms that are not to be a part of the main text flow.
this reason, subfigure.sty is not recommended for new work
Peter Williams’ and Rogerio Brito’s algorithmic.sty package
and will not be covered here.
[26] or Szász János’ algorithmicx.sty package [27] (the latter is
8
PDF is much like a subset of PostScript—the latter is a Turing complete
programming language, the former is not.
TABLE II TABLE III

A SIMPLE EXAMPLE TABLE THE SKEWING ANGLES (β) FOR Mu(H) + X2
AND Mu(H) + HX
a
First Next
H(Mu) + F2 H(Mu) + Cl2
1.0 2.0
β(H) 80.9◦b 83.2◦
β(Mu) 86.7◦ 87.7◦
a
designed to be more customizable than the former) may be of for the abstraction reaction, Mu + HX →
MuH + X.
help in producing algorithm-like structures (although authors b
1 degree = π/180 radians.
are of course free to use whatever LATEX commands they
are most comfortable with in this regard). However, do not use
the floating algorithm environment of algorithm.sty (also by the corners where lines meet are improperly formed; and (2) it
Williams and Brito) or algorithm2e.sty (by Christophe Fiorio) is not very flexible in terms of user control. For these reasons,
as the only floating structures IEEE uses are figures and authors are urged to look into some of the other packages
tables. Furthermore, IEEEtran will not be in control of the for making tables. A good one that provides revised “drop-in
(non-IEEE) caption style produced by the algorithm.sty or replacements” for both the tabular and array environments is
algorithm2e.sty float environments. Frank Mittelbach’s and David Carlisle’s array package [28].
Even more powerful (and complex) is the tabular and array
environments provided by the mdwtab.sty package which is
C. Tables
part of Mark Wooding’s MDW Tools [17].
Tables are handled in a similar fashion, but with a few As an alternative, IEEEtran offers the IEEEeqnarraybox
notable differences. For example, the code command which can also be used to produce tables9 of high
\begin{table}[!t] quality. See Appendix F for more details.
\renewcommand{\arraystretch}{1.3} 1) Footnotes Within Tables: Footnotes normally cannot be
\caption{A Simple Example Table}
\label{table_example} placed directly within some commands and environments such
\centering as \parbox, tabular, etc., because they become “trapped”
\begin{tabular}{c||c} inside. One way around this is to split the place the footnote
\hline
\bfseries First & \bfseries Next\\ marker (\footnotemark) is located (within the table) from
\hline\hline where the footnote text itself is declared (outside of the table
1.0 & 2.0\\ using \footnotetext).
\hline
\end{tabular} Another approach is to use the footnote.sty package (which
\end{table} is part of Mark Wooding’s MDW Tools [17]) which allows
environments to be configured so as not to trap footnotes:
results in Table II. Note that the IEEE places table captions
before the tables and, given that they serve much like titles, \usepackage{footnote}
\makesavenoteenv{tabular}
are usually capitalized except for words such as a, an, and, as,
at, but, by, for, in, nor, of, on, or, the, to and up, which are Note that is probably not a good idea to use footnotes in
usually not capitalized unless they are the first or last word of floating structures (like table) because the position of each
the caption. can move relative to one another. To put the footnote at the
Be aware that, to prevent a change of meaning that would end of a table instead of at the bottom of the page, just
result from case changes, the IEEE generally uses the standard enclose tabular, etc., inside a minipage (no footnote package
text font, not the small caps font, when rendering units as well needed). A very good approach for handling footnotes within
as letters in math in table captions. This can be achieved via tables (including those that float) is to use Donald Arseneau’s
the use of \upshape: threeparttable package [29] which was used to generate Table
\caption{Diagnosis of Rotor Faults in a DRFOC Drive III (the code of which is an example in the threeparttable.sty
U sing the VCT(Flux Loop Bandwidth (FLB) = 10 {\ file).
upshap e Hz}; 75% Load; 1450 {\upshape r/min})}
Thanks to Zhaowen Hou for providing information on this D. Double Column Floats
topic as well as the above example.
LATEX’s figure* and table* environments produce
Within the table environment, the default text size is foot-
figures and tables that span both columns. This capability is
notesize which is what IEEE typically uses for tables. When
sometimes needed for structures that are too wide for a single
using the tabular environment to construct tables, it is usually
column.
a good idea to increase the value of \arraystretch above
It is a limitation of the LATEX 2ε kernel that double
unity to “open up” the table rows a tad. Also, IEEE often column floats cannot be placed at the bottom of pages.
uses tables with “open sides,” (without vertical lines along That is to
each side) although the “closed side” form (e.g., Table I) is say “\begin{figure*}[!b]” will not normally work as
more commonly used for the tables within this document. intended. Authors that need this capability should obtain and
Unfortunately, the standard LATEX 2ε tabular load Sigitas Tolušis’ stfloats package [19] which patches the
environment has a number of shortcomings. Two notable
problems are (1) 9
Table I was made using this command.
1
LATEX 2ε output routine to allow it to handle double relative to the equations of the main text (that is to say a
column floats at the bottom of pages. Please note that stfloats set of double column equations can be at the top or bottom
is a very invasive package which may not work with versions of a page in which they would normally appear in the middle
of LATEX other than the standard LATEX 2ε release and had they been regular equations), the double column equation
may cause problems with other packages that modify the numbers must increase as one progresses down the page (i.e.,
output and/or float routines (such as those that balance double column equations at the bottom of a page must be
columns, alter the placement of floating figures, etc.). IEEE of higher number than those at the top). Furthermore, double
authors are warned not to use packages that allow material to column equations should appear on the same page where they
be placed across the middle of the two text columns (such as are referenced (on the page they would have appeared had
cuted.sty, midfloat.sty, etc.) as the IEEE does not do this. they been regular equations). Compounding the difficulty even
Another LATEX 2ε limitation (patched with stfloats or not) further is the fact that LATEX 2ε will not place double
is that double column floats will not appear on the same page column equations on the same page on which they are defined.
where they are defined. So, the user will have to define such
Finally, the IEEE does not generally allow other figures or
things prior to the page on which they are to (possibly) appear.
tables to come between the double column equations and the
LATEX 2ε (patched with stfloats or not) does not attempt
main text (which are separated from each other by a rule). All
to keep double and single column floats in sequence with
of this means that the place where a double column equation
each other. This can be fixed by loading Frank Mittelbach,
must be defined has to be “disconnected” from the place
David Carlisle and Chris Rowley’s fixltx2e package (already
where it will eventually be referred to in the text—and the
installed on most LATEX systems) [30]. Note that
user will have to manually intervene in the equation
fixltx2e.sty is the replacement (and superset) of the older
numbering system.
fix2col.sty [30]. However, fixltx2e/fix2col should not be used
Therefore, users have to (1) define double column
with the stfloats package as they both modify some of the
equations on the page prior to the one that they are to appear;
same float routines in different ways.
(2) reset the equation counter when the double column
Be aware that LATEX 2ε kernels dated 2015 and later equations are defined so as not to disturb the regular
have fixltx2e.sty’s corrections already built into the system in
equation numbers;
which case a warning will be issued if an attempt is made to
(3) manually set the double column equation numbers and (4)
load
increment the equation counter at the point the double column
fixltx2e.sty as it is no longer needed.
equations are referenced in the text so that they are accounted
Morten Høgholm’s dblfloatfix package [31] provides the
combined functionality of both the fixltx2e and stfloats pack- for in the numbering of the regular equations after that point.
ages and is now the recommended way to obtain these To do all of this, it is convenient to have a “scratch pad”
features. counter to temporarily save equation numbers. This can be
done via a command such as
Finally, authors should also be aware that the LATEX 2ε
kernel (patched with stfloats or not) has a long standing \newcounter{MYtempeqncnt}
limitation in that it will not allow rubber space that spans
both columns in the preamble of the document. Now, the double column
to stretch or shrink as needed for each of the two main text equations are defined on the page prior to the one in which
columns. Therefore, it is possible for double column floats to they are to appear (and in this example supposed that they are
cause underfull vbox errors because the remaining text height to be equation numbers six and seven):
may not be equal to an integer number of normal size lines.
\begin{figure*}[!t]
The problem can occur in main text columns (on pages with % ensure that we have normalsize text
double column floats) that do not have vertical rubber spacing \normalsize
% Store the current equation number.
(such as that around section headings, equations, etc.) and \setcounter{MYtempeqncnt}{\value{equation}}
results in underfull vbox warnings coupled with paragraphs % Set the equation number to one less than the one
that are “pulled apart” from each other. To correct this, users % desired for the first equation here.
can manually tweak the amount of space between the double % The value here will have to changed if equations
% are added or removed prior to the place these
column structure and main text by inserting a command like % equations are referenced in the main text.
\setcounter{equation}{5}
\vspace*{-3pt}
\begin{equation}
\label{eqn_dbl_x}
(adjusted as needed) within the double column structure. Inci- x = 5 + 7 + 9 + 11 + 13 + 15 + 17 + 19 + 21+ 23 + 25
dentally, IEEEtran automatically compensates for this problem + 27 + 29 + 31
when forming the paper title. \end{equation}
\begin{equation}
1) Double Column Equations: It is possible, but not pleas- \label{eqn_dbl_y}
ant, to use figure* to obtain double column equations. The y = 4 + 6 + 8 + 10 + 12 + 14 + 16 + 18 + 20+ 22 + 24
IEEE rarely uses double column equations because they can + 26 + 28 + 30
\end{equation}
waste space, so this capability is easy to abuse. Authors % Restore the current equation number.
who are considering the use of a double column equation \setcounter{equation}{\value{MYtempeqncnt}}
should verify that there are a few examples of such in papers % The IEEE uses as a separator
\hrulefill
previously published in the journal they plan to submit to. % The spacer can be tweaked to stop underfull vboxes.
There are complications. Although the IEEE does not place \vspace*{4pt}
constraints on the order of the double column equations \end{figure*}
x = 5 + 7 + 9 + 11 + 13 + 15 + 17 + 19 + 21 + 23 + 25 + 27 + 29 + 31 (6)
y = 4 + 6 + 8 + 10 + 12 + 14 + 16 + 18 + 20 + 22 + 24 + 26 + 28 + 30 (7)
The result of which is shown at the top of this page. This The IEEEtran IED lists ignore all “external” changes to the list
technique allows the definition of the equations to be posi- length parameters. Instead, IED lists are controlled exclusively
tioned arbitrarily as needed so that the (floating) equations via two interfaces:
will appear where desired. The “[!t]” option forces
1) “global” control via the \IEEEiedlistdecl
LATEX to do its best to place the equations at the top of the
command; and
next page. Had it been “[!b]” instead, then the stfloats (or even
2) “local” control via an optional argument that can be
better, dblfloatfix) package would need to be loaded and the \
provided to \itemize, \enumerate, and \descrip
vspac e command, followed by the \hrulefill
tion.
command, would have to occur before the equations in the
For example, declaring
figure.
The double column equations can then been referenced in \renewcommand{\IEEEiedlistdecl}{\settowidth{\labelwi
dth}{Hello}}
the main text like:
in an IEEEtran document will set the default width of the
% The previous equation was number five.
% Account for the double column equations here. label boxes in all later IED lists to be equal to the width
\addtocounter{equation}{2} of “Hello”. Note: Because setting a \labelwidth is so
As can be seen in (\ref{eqn_dbl_x}) and (\ commonly performed, IEEEtran provides a command: \IEEE
ref{eqn_dbl_y}) at the top of the page ...
setlabelwidth{X} which is a shorter form of: \settowid
Thankfully, double column equations are rare. th{\labelwidth}{X}.
The local control is used if the parameters are to apply only
to an individual IED list:
XI. L ISTS \begin{itemize}[\IEEEsetlabelwidth{$\gamma$}]
The traditional L AT
EX itemize, enumerate and Within an IED list, the local control is executed just after the
description (IED) list environments are ill-suited for producing global control and therefore, the commands in the local
the style of lists used in IEEE publications. The main problem control can both augment and countermand those in the global
is that they do not provide the user a means for controlling the control. Please note that the code in the local and global
parameters of the resultant list. Furthermore, making global controls are executed in the same manner as normal LATEX
changes to the parameters of the underlying \list will result code. Therefore, the user should ensure that unwanted blank
(often unexpectedly to a user) in the improper behavior of spaces do not appear in the controls. If a control definition is
other commands that depend on it, such as \quote. Finally, too long to fit on one line, shield the end of lines with “%”
LATEX’s \list considers the left margin of the list text to to prevent them from being interpreted as blanks (Section IV-
be the reference point that determines how the list is B1 has some information on this topic). Also, note that
positioned relative to the left margin of the main text: the LATEX
\labelwidth
..,. \labelsep
..,. parser requires that braces be placed around commands with
optional arguments that are placed directly within the optional
Label List Text arguments of other commands:
,.
\leftmargin . \begin{itemize}[{\mycmd[1]{example}}]
.
This contrasts with IEEE lists which use the label box as This IEEEtran IED implementation makes it easy to control
the reference point for the list structure. i.e., for a given IED lists, even when they are deeply nested.
circumstance, the list labels will be indented by a certain The default spacings the IED lists use are stored in various
amount, the list text block will be indented from the label length (not macro) commands. Changes to these “master”
boxes by a given amount and these spacings will determine defaults are rarely needed and should be done only at the
the position of the list text. beginning of the document, not in the IED list controls. These
For these reasons, IEEEtran provides enhanced IED list constants will now be briefly explained.
environments that make it much easier to produce IEEE style \IEEEilabelindent: This length is the default amount
lists. The underlying \list remains the same as in the itemized list label boxes are indented from the left mar-
traditional LATEX so as not to break code that depends upon gin. The IEEE seems to use at least two different values.
it. IEEEtran uses a new length variable, \IEEElabelindent, For example, in the IEEE/OSA J OURNAL OF LIGHTWAVE
so that users can specify IED list structures directly in IEEE T ECHNOLOGY and the IEEE J OURNAL ON S ELECTED A R-
fashion:
\labelwidth
\labelsep EAS IN COMMUNICATIONS, they tend to use an indention
\IEEElabelindent
..,. ..,. List Text
Label
equal to \parindent, while for IEEE 1
TRANSACTIONS ON COMMUNICATIONS they
tend to indent itemized lists a little more
(1.3\parindent). The shorter length is
stored as \IE
EEilabelindentA and the longer as \IEEEilabelindent

just use \IEEEnocalcleftmargintrue in a list control.
B. The default is to use the shorter version. To use the longer
This feature should not be needed during the course of normal
version do a IEEE related work.
\setlength{\IEEEilabelindent}{\IEEEilabelindentB} IEEEtran provides a means to manually specify the
at the beginning of the document. justification within the IED list label boxes. The commands
\IEEEelabelindent: This length is the default amount \IEEEied labeljustifyl, \IEEEiedlabeljustifyc
the enumerated list label boxes are indented from the left and \IEEEied labeljustifyr can be used in a list control
margin. Normally, the same as \parindent. to justify the list labels to the left, center, and right sides,
\IEEEdlabelindent: Ditto for description list labels. respectively. Itemize and enumerate lists automatically default
Nor- mally, the same as \parindent. to right justification, while description defaults to left
\IEEEiednormlabelsep: This length is the normal de- justification. The justification commands should not be needed
fault spacing between the IED list label boxes and the list during the course of normal IEEE related work.
text. In addition to modifying the behavior of itemize, enumer
\IEEEiedmathlabelsep: For nomenclature description ate and description, IEEEtran also provides the
lists (a list of math symbols and their explanations), the IEEE respective aliases IEEEitemize, IEEEenumerate and
usually increases the separation between the terms and the IEEEdescript ion, which provides a way for the user to
definitions. This length is set to the longer than normal length. access the IEEE style list environments even in the event
To invoke its use, just issue the command \IEEEusemathla another package is loaded that overrides the IED list
belsep in a list control. environments. For special- ized applications, the original
\IEEEiedtopsep: This length is the extra vertical sepa- LATEX IED list environments are retained as
ration put above and below each IED list. The IEEE usually LaTeXitemize, LaTeXenumerate and LaTeXde
puts a little extra spacing around each list. However, this extra scription.
spacing is barely noticeable.
\IEEElabelindentfactori through \IEEElabelin A. Itemize
dentfactorvi : These contain the factors by which the
The itemized lists will normally automatically calculate the
effective \IEEElabelindent is reduced as the list nesting
width of whatever symbol the current list level is using so that
depth increases. The IEEE normally decreases the amount of
a user can just call \begin{itemize}...\end{itemize}
indention as the list nesting level increases because there isn’t
without doing anything special. Furthermore, the auto-label-
much room to indent with two column text. IEEEtran has
width feature will work properly even if \labelitemX has
an “automatic indention cut-back” feature that provides this
behavior. The actual amount the label boxes will be indented been redefined (where “X” indicates “i,ii, .. iv”, whichever
is \IEEElabelindent multiplied by the \
is appropriate) before the list begins. However, if any item
symbols are to be specified via \item[X] (this is rare and
IEEElabelinden tfactorX corresponding to the level of
may well be nonstandard as far as IEEE related work is
nesting depth (where “X” is the nesting depth in roman
concerned), then the following form can be used:
numerals). This provides a means by which the user can alter
the effective \IEEElabel indent for deeper levels. There \begin{itemize}[\IEEEsetlabelwidth{Z}]
may not be such a thing as correct “standard IEEE” values. \item[X] blah
\item[Y] blah
What the IEEE actually does may depend on the specific .
circumstances. The first list level almost always has full .
indention. The second levels usually have only 75% of the \end{itemize}
normal indentation. Third level and greater nestings are very where “Z” is the longest label in the list.
rare, and probably don’t use any indentation. These factors are
not lengths, but rather constant macros like \
baselinestretch so \renewcommand should be used if B. Enumerate
they need to be changed. The default values are The important thing to note about enumerated lists is that
\IEEElabelindentfactori 1.0 the \labelwidth will default to the length of “9)” in the
\IEEElabelindentfactorii 0.75 normal size and style. Therefore, the width of the longest label
\IEEElabelindentfactoriii 0.0
\IEEElabelindentfactoriv 0.0 will have to be manually specified if any of the following
\IEEElabelindentfactorv 0.0 conditions are true:
\IEEElabelindentfactorvi 0.0
1) a top level list has more than 9 items;
The use of these factors in IED lists may be suspended by 2) a relevant \labelenumX or \theenumX has been
issuing the command \IEEEnolabelindentfactortrue redefined;
in a list control (which has the same effect as setting all the 3) \item[X] has been used to manually specify labels;
indent factors to 1.0). 4) the labels are using a font that is not the normal size
Normally, IEEEtran automatically calculates \ and style;
leftmargin based upon the current values of \ 5) the enumerated list is nested (i.e., not at the top level)
IEEElabelindent, \labe lwidth and \labelsep. To and is therefore not using Arabic digits as labels.
stop this auto-calculation so that a manually specified value of For example:
\leftmargin is used instead,
1
\begin{enumerate}[\IEEEsetlabelwidth{12)}] Sometimes it is desirable that a structure share its counter

\item blah with another structure. This can be accomplished by using the
\item blah
. alternate form of \newtheorem
. \newtheorem{struct_type}[num_like]{struct_title}
% 12 items total
\end{enumerate}
where num_like is the name of an existing structure.
IEEE theorem numbers are prefixed by the section number
they were defined in (e.g., 2.5). This presents a difficulty with
C. Description appendices (especially when numbered with Roman numerals)
Generally speaking, the longest label width will always because the theorem numbers will not be unique. To remedy
have to be specified for description lists. Furthermore, the this, within Roman numbered appendices, IEEEtran will add
author may wish to use \IEEEmathlabelsep for \ an “A” prefix (e.g., A2.5). For Alpha number appendices,
labelsep when building a math symbol list. For example: theorem numbering is more straightforward (e.g., A.5, B.5,
\begin{description}[\IEEEsetlabelwidth{$\alpha\omega etc.). For a single appendix, a constant “A” prefix is used (e.g.,
\pi\theta\mu$}\IEEEusemathlabelsep] A.5).
\item[$\gamma\delta\beta$] Is the index of..
\item[$\alpha\omega\pi\theta\mu$] Gives the..
. A. Proofs
.
\end{description} Proofs are easily handled by the predefined IEEEproof
environment:
Sometimes it can be difficult to ascertain from inspection
which of the labels is the longest. For such cases, a little \begin{IEEEproof}
.
diagnostic code may be helpful to measure a length and then .
to display the result on the console: \end{IEEEproof}
\newlength{\mydiaglen} % put in preamble The Q.E.D. symbol “ ” is automatically placed at the end of
.
. each proof. If needed, the symbol can be manually accessed
\settowidth{\mydiaglen}{$\alpha\beta\gamma$} via the \IEEEQED command. Both the closed (default) “ ”
\showthe\mydiaglen and open “ ” forms are provided as \IEEEQEDclosed and
\IEEEQEDopen, respectively. To change the default from
closed to open (some journals and/or authors prefer the open
XII. T HEOREMS AND PROOFS
form), just redefine \IEEEQED as desired:
Theorems and related structures such as axioms, corollaries
\renewcommand{\IEEEQED}{\IEEEQEDopen}
and lemmas, are handled in the traditional LATEX fashion. The
user must first declare the structure name via the IEEEproof also supports an optional argument which allows
\newtheorem{struct_type}{struct_title}[in_counter] the default string “Proof” to be overridden:
\begin{IEEEproof}[Proof of Theorem \ref{thm:my}]
command where struct_type is the user chosen identifier
for the structure, struct_title is the heading that is used
for the structure and in_counter is an optional name of a XIII. END S ECTIONS
counter whose number will be displayed with the structure
number and whose update will reset the structure counter. A. Appendices
Most IEEE papers use sequential theorem numbering The \appendix command is used to start a single
throughout the entire work, so an in_counter is usually not appendix. An optional argument can be used to specify a
specified. However, those papers that do use in_counter title:
usually use “section” such that the section number is the \appendix[Proof of the Zonklar Equations]
first part of each theorem number. After the structure is
defined it can be used via After issuing \appendix, the \section command will be
\begin{struct_type}[extra_title]
disabled and any attempt to use \section will be ignored
. and will cause a warning message to be generated. (The
. single appendix marks the end of the enumerated sections
\end{struct_type}
and the section counter is fixed at zero—one does not state
where extra_title is an optional name that is displayed “see Appendix A” when there is only one appendix, instead
with the structure. “see the Appendix” is used.) However, all lower \subsecti
For example, the most common way to do theorems would on commands and the \section* form will work as normal
be to use as these may still be needed for things like acknowledgments.
\appendices is used when there is more than one ap-
\newtheorem{theorem}{Theorem}
pendix section. \section is then used to declare each ap-
followed as needed by environments like pendix:
\begin{theorem}[Einstein-Podolsky-Rosenberg] \section{Proof of the First Zonklar Equation}
The mandatory argument to section can be left blank ( \sect

.
ion{}) if no title is desired. It is important to remember to \end{IEEEbiography}
declare a section before any additional subsections or labels
that refer to section (or subsection, etc.) numbers. As with \a Note the extra set of braces that are required to prevent the
ppendix, the \section* command and the lower \subsec LATEX parser from becoming confused when commands
tion commands will still work as usual. with optional arguments are used within an optional argument
There are two appendix numbering conventions used by of another command. Alternatively, a LATEX macro
IEEE. Capital letters (e.g., “Appendix B”) and Roman nu- (command) could be defined to facilitate a shorthand notation
merals (e.g., “Appendix II”). The former appears to be more for the author photos. If the optional argument is not used,
popular and is the IEEEtran default. Use the IEEEtran class space will be reserved for a photo and the message “PLACE
option romanappendices to get Roman numbered appendices. PHOTO HERE” will be displayed in place of a photo.
Some authors prefer to have the appendix number to be part IEEEtran is a tad overly cautious about preventing the
of equation numbers for equations that appear in an appendix. IEEEbiography photo area from being broken across pages.
This can be accomplished by redefining the equation numbers If it looks as though a IEEEbiography should be able to be
as “squeezed” at the end of a page, but instead it begins on a
new page, try inserting
\renewcommand{\theequation}{\thesection.\arabic{equa
tion}} \vspace*{-2\baselineskip}
before the first appendix equation. For a single appendix, the or so before the IEEEbiography and see if it can fit.
constant “A” should be used in place of \thesection. IEEE’s algorithm for spacing around biographies can be a
tad complex because esthetics must be considered. IEEEtran
places \vfil above biographies. This allows the user to
B. Acknowledgments
shove biographies down or up as desired by placing the
Acknowledgments and other unnumbered sections are cre- infinitely more stretchable \vfill before or after the
ated using the \section* command: biographies.
\section*{Acknowledgment} The photo area is 1 in wide and 1.25 in long. The IEEE
\addcontentsline{toc}{section}{Acknowledgment} recommends that author photo images should be of 220 dpi
The second, optional, command is needed to manually add (dots per inch) resolution and in gray scale with 8 bits/sample.
such sections to the table of contents (which is rarely used, If no photo is available, the \IEEEbiographynophoto
but some authors may do so with draft papers) as well as the environment, which does not support an optional argument
document’s PDF bookmarks (if using hyperref.sty). or reserve space for a photo, can be used instead.
Note that IEEE Computer Society papers typically use the
plural form “Acknowledgments”. XIV. LAST PAGE C OLUMN E QUALIZATION
The IEEE (coarsely) equalizes the lengths of the columns
C. Bibliographies on the last page. The balance is coarse in the sense that
Bibliographies are most easily (and correctly) generated reference or IEEEbiography entries are not usually broken—
using the IEEEtran BIBTEX package [32] which is easily so the column lengths are not usually perfectly equal.
invoked via Balancing the last two columns is especially important for
camera ready work. It is recommended that authors use the
\bibliographystyle{IEEEtran}
\bibliography{IEEEabrv,mybibfile}
manual approach by putting in \newpage at the appropriate
point or \enlargethispage{-X.Yin} somewhere at the
See the IEEEtran BIBTEX package documentation for more top of the first column of the last page where “X.Yin” is the
information. amount to effectively shorten the text height of the given page.
When submitting the document source (.tex) file to external Sometimes such a command has to be located between
parties, it is strongly recommended that the BIBTEX .bbl file bibliography entries. This can be a problem because, although
be manually copied into the document (within the traditional the command can be placed within the .bbl file, it will get
LATEX bibliography environment) so as not to depend overwritten the next time BIBTEX is run. For this situation,
on external files to generate the bibliography and to prevent IEEEtran offers a way to invoke commands just before a given
the possibility of changes occurring therein. reference number via the \IEEEtriggeratref{}
command. For instance, issuing the command
D. Biographies \IEEEtriggeratref{10}
Biographies for journal articles are created using the IEEE- before the bibliography will insert a page break just before
biography environment which supports an optional argument reference number ten. The command that is executed defaults
for the inclusion of a photo: to \newpage. However, this can be changed via the \IEEE
\begin{IEEEbiography}[{\includegraphics[width=1in,he triggercmd command:
ight=1.25in,clip,keepaspectratio]{./shell}}]{Michael
Shell} \IEEEtriggercmd{\enlargethispage{-5.35in}}
.
Note that manually set break points or page sizes will have to
be readjusted if the document content ever changes.
1
There are LATEX packages, such as balance.sty [33] initexmf -u

and flushend.sty [34], that are designed to automatically
balance the columns on the last page. Flushend does not to accomplish the same thing.
require the placement of any special command in the first Users not willing or able to install the files system-wide can
column of the last page, balance.sty may. However, the use of install them in their personal directories, but will then have to
these packages is not recommended because they are known provide the path (full or relative) in addition to the filename
to be less than perfectly reliable in their operation. The author when referring to them in LATEX.
of balance.sty does not guarantee that it will work with every
possible type of page, especially pages with figures. Under APPENDIX B
certain circumstances, flushend.sty will cause a spacing POSTSCRIPT/PDF OUTPUT
anomaly between two lines within a reference in the second Some LATEX systems are not properly configured to
column of the last page (becomes larger than the space produce quality PostScript and/or PDF output. This has
between references). This problem seems to result because the historically been more of a problem with IEEE-related work
bibliography in IEEEtran is a list with zero space between the because the unique font combination the IEEE uses has been
list items which are in footnotesize. The problem can also known to trigger problems with some LATEX setups.
occur under article.cls for the same type of list. It may be Fortunately, these types of problems are now relatively
possible to manually correct the flushend anomaly by uncommon on modern LATEX systems.
tweaking the spacer at the column break via a flushend To assist IEEE authors in detecting and correcting prob-
command such as “\atColsBreak{\vs kip-2pt}”, but lems with LATEX PostScript/PDF generation, the
having to do so partially defeats the purpose of using the “Testflow” diagnostic suite was developed [35]. Authors are
package in the first place. If using flushend.sty or balance.sty, encouraged
be sure to check the document carefully for any spacing to take the time to go through the testflow diagnostic and
problems—especially on the last page. identify and correct potential problems before their
LATEX systems have to be relied on for production work.
APPENDIX A Papers with problems such as incorrect margins, font types,
INSTALLING IEEETRAN PDF format errors and/or improper font embedding can incur
First of all, users should be aware that, depending on the delays during the manuscript acceptance process.
target operating system of the IEEEtran archive packaging
(e.g., .tar.gz for Unix, or .zip for MS Windows), the plain text APPENDIX C
based IEEEtran files (.bst, .cls, .sty, .tex, etc.) may use one of OTHER USEFUL OR RELATED EXTERNAL PACKAGES
two different types of end-of-line character conventions. Unix
A. The acronym.sty Package
(including Mac OS X) systems use line feed <lf> (0x0A),
while MS Windows systems use carriage return/line feed pairs Tobias Oetiker’s acronym.sty [36] may be useful with
<cr><lf> (0x0D 0x0A) to signal the end of lines. 10 Most papers that have a lot of acronyms. However, beware of a
modern LATEX systems are tolerant of differing end-of- compatibility issue between the acronym environment and the
line conventions, but some text editors aren’t. (Symptoms here IEEEtran description lists (see Appendix E).
include text appearing all on one long line, double spacing,
etc.) B. The url.sty Package
LATEX .cls files can be accessed system-wide when they are Papers that contain URLs, email address, etc., can likely
placed in the <texmf>/tex/latex directory, where <tex benefit from the use of Donald Arseneau’s url.sty
mf> is the root directory of the user’s TEX installation. On LATEX package [37] which provides for more intelligent line
systems that have a local texmf tree (<texmflocal>), which breaking within such structures. Note that IEEEtran.cls
may be named “texmf-local” or “localtexmf”, it may be automatically sets the url font style of url.sty to “same” (that
advisable to install packages in <texmflocal>, rather than is, URLs will be rendered in the same font as the text they
<texmf> as the contents of the former, unlike that of the
appear in) as IEEE journals do. To override this, the author
latter, are preserved after the LATEX system is reinstalled
must place the
and/or upgraded.
\urlstyle after \begin{document}.
It is recommended that the user create a subdirectory <t
exmf or texmflocal>/tex/latex/IEEE for all IEEE
related LATEX class and package files. On some LATEX C. The IEEEtrantools Package
systems, the directory look-up tables will need to be refreshed Some of the unique commands provided by the IEEEtran
after making additions or deletions to the system files. For LATEX class may be of use in non-IEEE related work
TEX Live systems this is accomplished via executing using other class files (e.g., dissertations, technical reports,
texhash etc.). The IEEEtrantools.sty package [38] provides several
popular IEEEtran commands including \IEEEPARstart, the
as root. MiKTEX users can run
IEEE style IED list environments, the IEEEeqnarray family of
10
The fact that different conventions exist for plain text is, of course, an commands, the IEEEproof environment and \IEEEauthor
absurdity in itself. See the Wikipedia article “Newline” at http://en.wikipedia. refmark. The IEEEtrantools package is not needed under,
org/wiki/Newline for the history and details.
and should not be loaded with, the IEEEtran class. See the
IEEEtrantools documentation for more details.
APPENDIX D Some IEEE conferences may be more liberal with regard to

COMMON USER MISTAKES the types of graphics formats they accept.
Many user mistakes with IEEEtran involve doing too much Using bitmapped fonts and/or not embedding and
rather than too little. Older class files may have required hacks subsetting all document fonts: Authors should check their
in order to get the formatting closer to that of the IEEE. These system with the testflow diagnostic [35] to ensure that only
tweaks are no longer needed. Users should carefully check vector (Type 1) fonts are being used and that all fonts are
all the loaded packages to ensure that they are still useful embedded and subsetted. A document that uses bitmapped
under the latest version of IEEEtran. Don’t load packages just fonts and/or fails to contain all (and only) the needed font
because “this is the way it always has been done.” The same glyphs may be rejected by the IEEE. Watch out for graphical
is true for manually adjusted spacing, margins, paper sizes, drawing applications that produce output with these problems
etc. (suspect this if the problem goes away when the figures are
Below are a few of the more commonly encountered mis- not included).
takes to avoid. Using older graphics packages: Authors should not use
Placing labels before captions: This is considered to be anything other than the graphics and/or graphicx (preferred)
one of the most frequent mistakes made in LATEX of all package for figures. Older interfaces such as psfig, epsf, etc.,
time. Remember that \label must be placed after or within \ have been obsolete for many years.
cap tion to be able to reference figures/tables properly. Failing to properly divide long equations: It is the
As it is author’s responsibility to ensure that all equations fit within
\caption that actually sets up the reference counter, \labe the width of their columns. Admittedly, breaking an equation
l’s placed prior to \caption will refer to the section is not always easy to do and two column formatting places
number, instead of the desired figure/table number. serious constraints on allowed equation width. However,
Altering the default fonts: Authors should allow IEEEtran only the author can divide his/her equation without
to manage the fonts. Unless specifically instructed otherwise, unintentionally altering its meaning or affecting readability.
such as under comsoc mode or in the author instructions of the Using subfunctions is a valid way to reduce to width of an
specific conference/journal being submitted to, do not attempt equation, but altering the math font size is not.
to use packages that override the default fonts such as pslatex, Manually formatting references: Not only is this error
mathptm, etc. prone, but requires a lot of work as well. It is better to use
Altering the default spacings, section heading styles, the IEEEtran BIBTEX style [32].
margins or column style: Authors should not attempt to
manually alter the margins, paper size (except as provided APPENDIX E
in IEEEtran class options) or use packages that do so (geom- KNOWN ISSUES
etry.sty, etc.). There should be no need to add spacing around acronym.sty: The acronym environment will have a prob-
figures, equations, etc., (except possibly for double column lem with IEEEtran because of the modified IEEE style
floats as described in Section X-D). description list environment. The optional argument of the
Using bitmapped graphics for line art: LATEX has acronym environment cannot be used to set the width of the
always favored the use of Encapsulated PostScript (EPS) or longest label. A workaround is to use \IEEEiedlistdecl to
under pdfLATEX, Portable Document Format (PDF), accomplish the same thing:
(which can be considered to be a type of subset of \renewcommand{\IEEEiedlistdecl}{\IEEEsetlabelwidth{S
PostScript), for graphics (see Section X-A for more ONET}}
\begin{acronym}
information), and for good reason. EPS/PDF supports both .
vector (that is, containing objects such as lines, circles, etc., .
that are mathematically described) and bitmap (that is, \end{acronym}
\renewcommand{\IEEEiedlistdecl}{\relax}% reset back
containing only samples in the form of pixels) images. The
former should always be used for drawings, graphs, charts, cite.sty: Versions prior to 5.0 (2009-03-20) will not hyper-
etc., while the latter usually has to be employed with link citation numbers under hyperref.sty.
photos (because their contents usually cannot be easily hyperref.sty: Versions prior to 6.72u will interfere with the
described mathematically). The drawing and graphing tools optional argument to \appendix.
used by the author should be capable of outputting directly11 in Small caps font variations: The small caps font used in
vector (EPS or PDF) format. Vector EPS/PDF images can be the free LATEX systems have about 80% the height of
scaled, rotated and magnified without undergoing degradation normal sized letters. However, the small caps font the IEEE
such as pixelization or becoming gray or “jaggedy.” For uses in the journals is slightly smaller with a ratio of around
photos, the IEEE recommends the use of EPS/PDF (which is 75%. So, the widths of the section headings produced under
easy to directly import into (pdf)LATEX in a portable the free LATEX systems will be slightly wider than that used
manner), PNG or TIFF. For author photos JPEG (JPG) is in actual journals. The small caps font used in many
usually acceptable. The use of other graphic formats such as commercial LATEX systems (such as those from YandY) has
BMP, EMF, VSD, etc., is unacceptable for IEEE journals. a ratio of about 65%. So, those systems will produce section
headings that are narrower than those in IEEE publications.
11
Once an image in EPS/PDF vector form is converted to a bitmap form Such variations should not be cause for concern.
(GIF, PNG, TIFF, JPEG, etc.) it will almost always be irretrievably locked
into bitmap form even if it is later converted back into EPS/PDF.
2
APPENDIX F prevent the LATEX parser from

THE IEEEEQNARRAY COMMANDS
(Optional—for advanced users)
Virtually all LATEX alignment commands such as \

eqnarr ay, \array and \tabular are based on the TEX
command
\halign. LATEX’s goal of simplifying the use of \halign
is
noble. However, in hiding much of the lower level interface, a
fair degree of flexibility is lost. This has resulted in the devel-
opment of several packages such as amsmath [11], array.sty
[28], and the MDW tools [17], each of which provides much
more powerful alignment structures.
IEEEtran also provides its own unique set of alignment
tools which are known as the IEEEeqnarray family. The
design philosophy of the IEEEeqnarray family is to provide a
LATEX alignment interface that is based more closely on the
underlying \halign, but to couple this with high level col-
umn definition management and automated preamble building
mechanisms (which are tedious to do in TEX). As a result,
the IEEEeqnarray family of commands are flexible enough
to be almost universal replacements for all the other
LATEX commands for producing multiline equations and
aligned box structures such as matrices and tables of text
and/or mathematics. Because the user is shielded less from
the \halign underpinnings, the rules of operation are more
involved. So, the IEEEeqnarray commands are aimed
primarily toward the more advanced LATEX users.
The use of the IEEEeqnarray family of tools described
in this section is totally optional. The IEEEeqnarray code
is self-contained and does not depend on other alignment
packages—which can be used along side, or in place of, it.
The IEEEtrantools.sty package (See Appendix C-C) is
available for those who wish to use the IEEEeqnarray family
outside of IEEEtran.cls.
Recommended sources of information on the use of IEEEe-
qnarray include Stefan M. Moser’s How to Typeset Equations
in LATEX [6] and Tobias Oetiker’s The Not So Short
Introduction
to LATEX 2ε [5].
A. IEEEeqnarray
The IEEEeqnarray environment is for multiline equations
that occupy the entire column. It is used in much the same
way as \eqnarray, but with two additional arguments, one
of which is mandatory and the other is optional:
\begin{IEEEeqnarray}[decl]{cols}
.
\end{IEEEeqnarray}
The optional argument is for commands that are to be

executed within the environment, but before the alignment
actually begins. This is just like the local control of the
IEEEtran IED list environments. There is also a global
control, \IEEEeqnarray decl, which is executed just prior
to the local control. By default, \IEEEeqnarraydecl is
defined to be \relax. As mentioned in Section XI, users
should be careful not to allow unwanted spaces to occur in
these controls because such things will appear just before the
IEEEeqnarray structure. Furthermore, remember that, to
2 TABLE IV
JOURNAL OF LATEX CLASS FILES, VOL. 14, NO. 8, AUGUST
IEEEEQNARRAY PREDEFINED COLUMN TYPES
I.D. Description I.D. Description

l left math v vertical rule
c centered math vv two vertical rules
r right math V double vertical rule
L left math with ords VV two double vertical rules
C centered math with ords h horizontal rule
R right math with ords H double horizontal rule
s left text x empty
t centered text X empty math
u right text
Note: S, T, U, p, and P are likely to be used in future versions.
TABLE V
IEEEEQNARRAY PREDEFINED COLUMN SEPARATION (GLUE)
TYPES
I.D. Width* I.D. Width

! −1/6 em . 0.5\arraycolsep
, 1/6 em / 1.0\arraycolsep
: 2/9 em ? 2.0\arraycolsep
; 5/18 em * 0pt plus 1fil
’ 1 em + 1000pt minus 1000pt
" 2 em - 0pt
*
All em values are referenced to the math font.
1 em = \quad, 2 em = \qquad
becoming confused, the contents of an optional argument

must be enclosed in braces if the argument contains
commands with optional arguments.
The mandatory argument cols contains the column and
inter-column separator spacing (“inter-column tabskip glue”
in TEXspeak) type specifiers. Column types are identified by
letters. Several predefined column types are available as
shown in Table IV. There are two kinds of glue types.
Predefined glue types are indicated by various punctuation
marks as shown in Table V. User defined glue types are
indicated by numbers.
The rules for placing these specifiers are as follows: (1) no
two glue specifiers can appear next to each other—they are
not additive and must be separated from each other by at
least one column specifier; (2) zero inter-column spacing
will be assumed between back-to-back column specifiers; (3)
because of rule one, back-to-back numerals will be
considered as being a single glue specified by the numerical
value represented by all the digits; (4) a multiletter column
specifier can be accessed by enclosing the letters within
braces (otherwise it would be interpreted as being several
single letter column specifiers). Because of rule three, braces
are not needed around multidigit glue specifiers; (5) there
must be at least one column specifier, but there is no fixed
upper limit of how many columns can be supported; and (6)
for \IEEEeqnarray, “+” centering glue will be assumed at
each end of the cols specification if no column glue is
specified there. This results in a centered structure like \
eqnarray (the 1000pt minus 1000pt glue on each side
“compresses” as needed from each side of the main text
column to center that which is between). Also, \IEEE
eqnarray automatically adds a hidden column for
equation
2
numbers to the right of the last specified column. Currently,

For reference, the definitions of the predefined column
there is no support for equation numbers on the left side.12 types are shown here:
% math
B. Defining Column Types \IEEEeqnarraydefcol{l}{$\IEEEeqnarraymathstyle}{$\hfil}
\IEEEeqnarraydefcol{c}{\hfil$\IEEEeqnarraymathstyle}{$\hfil}
New column types are defined with the \IEEEeqnarraydefcol{r}{\hfil$\IEEEeqnarraymathstyle}{$}
\IEEEeqnarraydefcol{L}{$\IEEEeqnarraymathstyle{}}{{}$\hfil}
\IEEEeqnarraydefcol{col_id}{predef}{postdef} \IEEEeqnarraydefcol{C}{\hfil$\IEEEeqnarraymathstyle{}}{{}$\h
fil}
command. The col_id argument contains the name of the \IEEEeqnarraydefcol{R}{\hfil$\IEEEeqnarraymathstyle{}}{{}$}
column specifier which should consist only of one or more % text
\IEEEeqnarraydefcol{s}{\IEEEeqnarraytextstyle}{\hfil}
letters. A given column specifier, even the predefined ones, \IEEEeqnarraydefcol{t}{\hfil\IEEEeqnarraytextstyle}{\hfil}
can be redefined at will without warning or error. 13 The \IEEEeqnarraydefcol{u}{\hfil\IEEEeqnarraytextstyle}{}
% vertical rules
predef argument contains the commands that will be \IEEEeqnarraydefcol{v}{}{\vrule width\arrayrulewidth}
inserted before each cell in the column. The postdef \IEEEeqnarraydefcol{vv}{\vrule width\arrayrulewidth\hfil}{\h
fil\vrule width\arrayrulewidth}
argument contains the commands that will be inserted after \IEEEeqnarraydefcol{V}{}{\vrule width\arrayrulewidth\hskip\d
each cell in the column. For example, oublerulesep\vrule width\arrayrulewidth}
\IEEEeqnarraydefcol{VV}{\vrule width\arrayrulewidth\hskip\do
\IEEEeqnarraydefcol{g}{\hfil$\clubsuit$}{$\diamondsu ublerulesep\vrule width\arrayrulewidth\hfil}%
it$\hfil} {\hfil\vrule width\arrayrulewidth\hskip\doublerulesep\vrule
width\arrayrulewidth}
% horizontal rules
Will define a “g” text column which will place club and \IEEEeqnarraydefcol{h}{}{\leaders\hrule height\arrayrulewidt
diamond suit symbols on either side of a cell’s contents and h\hfil}
\IEEEeqnarraydefcol{H}{}{\leaders\vbox{\hrule width\arrayrul
center the respective structure within the cell. e.g., ewidth\vskip\doublerulesep\hrule width\arrayrulewidth}\hfil}
♣Hello♦ % plain
Using \hfil to control cell alignment allows the user \IEEEeqnarraydefcol{x}{}{}
\IEEEeqnarraydefcol{X}{$}{$}
to override the column alignment on a cell-by-cell basis by
placing the infinitely more stretchable \hfill on one or both Note the inclusion of the commands \IEEEeqnarraymat
sides of a cell’s contents. \hfill can even be placed hstyle and \IEEEeqnarraytextstyle in the math and
between items in a cell to force them apart and against the text columns, respectively. These commands allow the user
“cell walls.” The IEEEeqnarray predefined columns are to control the style of all of the math and text columns.
designed to allow user overrides via \hfill whenever However, because the changes apply to all the columns, the
possible (even for the math mode cells). user will have to define new column types if different styles
Please note that TEX will not allow unmatched braces are needed in the same alignment (or different styles can be
within the arguments of commands. If braces are needed, such manually specified in each cell). The default definitions for
as for the argument of a command, they will have to be these commands are
provided within the cells themselves. For example, \newcommand{\IEEEeqnarraymathstyle}{\displaystyle}
\IEEEeqnarraydefcol{myp}{\parbox[c]{0.5in}}{} \newcommand{\IEEEeqnarraytextstyle}{\relax}
\begin{IEEEeqnarraybox}{{myp}c}
{first\\second}&\alpha\\ &\ which allows the text columns to be in whatever style was in
beta% effect when the alignment was started and the default math
\end{IEEEeqnarraybox} style will be in display style, but can be easily changed as
defines a column type named “myp” that will place text within needed. e.g.,
a 0.5 inch wide parbox which is centered on the cell’s \begin{IEEEeqnarray}[\renewcommand{\IEEEeqnarraymath
baseline. Note that because the column type name consists of style}{\scriptstyle}]{rCl}
more than one letter, it has to be enclosed within an extra set will result in script style math columns.
of braces in the column specifications or else it would be The columns relating to vertical and horizontal lines will
interpreted as three adjacent columns “m”, “y” and “p”. Also, be discussed in Appendix F-K as they are typically used only
the contents of the cell must be enclosed within braces so that when producing tables.
(1) the \par box command sees the entire contents as its The “x” and “X” columns are basic empty text and math
argument; and (2) the newline within the parbox will not be mode columns without any formatting or style controls.
interpreted as being the end of the alignment row. Be aware
that it can happen that a column is given an empty cell, such C. Defining Glue Types
as in the second row in the example, or when entering blank
separator rows. When this happens, a \relax will appear in New column separation glue types are defined with the
the column which will be acquired as the command’s \IEEEeqnarraydefcolsep{colsep_id}{def}
argument. Therefore, commands in column definitions that command. The colsep_id argument contains the number of
acquire arguments from the cells should not choke if fed \ the column separation glue specifier which should consist only
relax. of numerals. Different glue type names must have different
12
This is not to say that its impossible with the existing capability, just numerical values. (Don’t get too cute—“007” is identical to
ugly. “7”.) User defined column glue specifiers can be redefined
13
Thus allowing new predefined column types to be added without at will without warning or error. The def argument
breaking existing code.
contains
the width of the given glue type. Widths may be specified as E. Equation Numbering
absolute values or reference length commands:
Like \eqnarray, \IEEEeqnarray, has a “star form,” \IE
\IEEEeqnarraydefcolsep{9}{10pt} EEeqnarray*, which does not place equation numbers at the
\IEEEeqnarraydefcolsep{11}{2\tabcolsep} end of each row by default. The default behavior of individual
rows can be overridden by placing the commands \IEEEye
The glue type widths are not evaluated when defined, but are
snumber or \IEEEnonumber as needed in the last column.
evaluated each time they are actually referenced as IEEEeq-
\IEEEeqnarray also provides \IEEEyessubnumber and \
narray column specifiers. Thus, for the second definition in
I EEEnosubnumber which can be used to enable or
the example above, if \tabcolsep were to be revised after
disable a subequation number for the given row. To support
the glue type was defined, the revised value would be what is
this feature, IEEEtran defines its own IEEEsubequation
used.
counter (reset with changes to equation) and \
Rubber lengths are allowed too. The fact that the centering
theIEEEsubequati on command.14
glue “+” is a known value can be exploited to achieve some
As of version 1.8 of IEEEtran, the star forms \IEEEyesn
interesting effects. For example,
umber*, \IEEEnonumber*, \IEEEyessubnumber* and \I
\IEEEeqnarraydefcolsep{17}{200pt minus 200pt} EEEnosubnumber* are available which persist across rows
until countermanded by another star command. The behavior
will produce a column separation glue that is always 1/5 of of later individual rows can be selectively overridden with the
the width of the distance from the equation sides to the ends use of the non-star forms as needed.
of the main text columns. And, of course, “ +” can be used as Despite there being four numbering commands, it is useful
needed to produce groups of equally spaced equations as in to remember that there are only three IEEEeqnarray
amsmath’s \align: numbering modes:
1) Display nothing and do not alter the counters ( \IEEEn
\begin{IEEEeqnarray}{Rl+Rl+Rl}
onumber);
2) Increment the equation counter and display an equation
number without a subequation part (\IEEEyesnumber);
D. A Simple Example of Use 3) Increment the subequation counter and display an equa-
tion number with a subequation number (\IEEEyessu
The example in Section IX can be implemented using
bnumber).
\IEEEeqnarray via
\IEEEnosubnumber is not really needed and behaves much
\begin{IEEEeqnarray}{rCl} like \IEEEyesnumber except that the former does not also
Z&=&x_1 + x_2 + x_3 + x_4 + x_5 + x_6\IEEEnonumber\\ enable equation numbering if it isn’t already on (and does not
&&+\:a + b%
\end{IEEEeqnarray}
alter the numbering properties of the current row if equation
numbering is off).
As shown in Table IV the “C” column type is a centered math Generally speaking, only one numbering command should
mode column with empty ords (“ {}”) on either side. So, there be used per row. In particular, mixing yes and no commands
is no need to place empty ords around the equal sign. As with on a single row could result in unintended operation. However,
\eqnarray, the & separate the column cells and are where a notable exception is the very useful \IEEEyesnumber\IEE
the inter-column separation glue will appear (when nonzero). Eyessubnumber combination which starts a new
Note the presence of the % at the end of the second row. subequation sequence. For example,
TEX does not ignore spaces that occur before commands or \begin{IEEEeqnarray}{c} x1\
IEEEyesnumber\IEEEyessubnumber*\\
& column delimiters, but does ignore those that occur after.
x2\\
Most LATEX alignment implementations shield the user x3\IEEEyesnumber\IEEEyessubnumber\label{eqn:expl}\\
from this behavior by removing all spacing previous to &, x4\\
\\ and x5\IEEEyesnumber*\\
x6
\end. The IEEEeqnarray family does not do this! So, it is \end{IEEEeqnarray}
important to prevent spaces (including implied ones at the end
of lines) from occurring before such commands unless they yields:
are wanted. Suspect this problem if there is an unexplained
x1 (8a)
offset within a column. In the given example, unwanted
spacing is not an issue because end spacing is ignored in math x2 (8b)
mode anyway. However, it would be an issue if the columns x3 (9a)
used text mode instead. x4 (9b)
Alternatively, one could use a two column form: (10)
x5
\begin{IEEEeqnarray}{Rl} x6 (11)
Z=&x_1 + x_2 + x_3 + x_4 + x_5 + x_6\IEEEnonumber\\
&+\:a + b% 14
What is actually displayed is the \theIEEEsubequationdis com-
\end{IEEEeqnarray} mand.
2
The \IEEEyesnumber command increments the equation

box command is provided. \IEEEeqnarraybox differs from
counter of what would otherwise have been a subequation
\IEEEeqnarray in the following ways:
row, resets the subequation counter and turns off subequation
numbering. The following \IEEEyessubnumber then incre- 1) the entire contents are wrapped within a box and there-
ments the subequation counter by one and restores fore, can be nested within other display or alignment
structures (such as \equation, \IEEEeqnarray or
subequation numbering.15
even another \IEEEeqnarraybox). Note that, like all
Note that any labels for (sub)equations must be placed
box structures, page breaks are not allowed between the
after any numbering control command(s) because, prior to that
rows of an \IEEEeqnarraybox;
point, the label will reference the equation number that would
have been used if there had not been any numbering control 2) the default glue at the outer ends of the first and last
columns is 0 pt (“-”), not “+” centering glue as with \I
commands.
EEEeqnarray;
Please be aware that \IEEEeqnarray, like \eqnarray,
will, if the equation is long enough, overwrite the equation 3) no automatic (hidden) equation number column is pro-
vided;
number without warning!16 For cases when this happens, users
can insert a \IEEEeqnarraynumspace command at the end 4) the star form “\IEEEeqnarraybox*” turns off the extra
\jot vertical spacing after each row;
of the line (after any \IEEEyessubnumber if used) which
5) \IEEEeqnarrayboxdecl is the global control.
will insert a space equal in width to the displayed equation
number: There are two subforms: \IEEEeqnarrayboxm which is
for use within math modes and is analogous to \array; and \
· · · + x_z \IEEEyessubnumber\IEEEeqnarraynumspace\\
IE EEeqnarrayboxt which is for use within text modes
As a result, the entire multiline equation will be slightly and is analogous to \tabular. If called via \
shifted to the left. The IEEE often does the same thing in its IEEEeqnarraybox the current math/text mode will be auto-
journals when confronted by this situation. If an overfull hbox detected and the proper subform will automatically be
results, the offending equation line will have to be further selected. Therefore, \IEEEeqn arraybox can replace \
divided. array as well as \tabular.
The syntax for \IEEEeqnarraybox is similar to \IEEEeq
narray, but with two additional optional arguments:
F. Extra Vertical Spacing and Page Breaks
\begin{IEEEeqnarraybox}[decl][pos][width]{cols}
Like \eqnarray, \IEEEeqnarray’s \\ command .
supports a star form which inhibits page breaks at the given \end{IEEEeqnarraybox}
line as well as an optional extra vertical spacing argument:
The pos argument can be one of t, c, or b to control where
&+\:a + b\\*[5pt] the box will be vertically aligned relative to the current
Users are reminded from Section IX that amsmath will baseline: t at the top row; c at the center;17 b at the bottom
configure LATEX to disallow page breaks within multiline row. The default is b.
equations—including those made by \IEEEeqnarray be- The width argument specifies the width the box.
cause it also honors the value of \interdisplaylinepen Warning: if a width is specified, there must be one or more
rubber lengths in the inter-column glue specifiers (such as that
alty.
of “*” or “+”) so that the box can be sized as needed. If there
Also like \eqnarray, \IEEEeqnarray normally places
is no
a small amount of extra spacing (as specified by the length
such glue, or the glue provided cannot stretch/shrink enough
command \jot) between lines to “open up” equations as well
as needed, the box cannot be sized to width and an underfull
as to prevent large symbols from coming to close to the lines
or overfull hbox error will result. If no width argument is
above them.
provided, the box will be set to its natural width (and the use
of rubber inter-column glue will not be required).
G. IEEEeqnarraybox \IEEEeqnarraybox uses the same column and glue type
\IEEEeqnarray is not suitable for producing structures specifiers/definitions as \IEEEeqnarray.
such as matrices and tables because it must have exclusive
access to the main text column and cannot be nested within H. Line Spacing in LATEX
other structures. For these applications, the \IEEEeqnarray
Before discussing some of the more advanced aspects of
15
Invoking only a \IEEEyessubnumber following a normal equation
vertical spacing control in the IEEEeqnarray family, it is im-
number line will result in a sequence like 14, 14a. The IEEE does not portant to review the details of LATEX’s line spacing
typically use normal equation numbers followed by subequations carrying algorithm. Normally, baselines are separated by the amount
that same base equation number, but the capability is there if you ever need it.
IEEEtran versions prior to v1.8 differed here in that they automatically given by the length command \baselineskip. With each
advanced the equation number on the “first” call to \IEEEyessubnumber change in font size, \baselineskip is reset to the default
and so did not have this degree of flexibility. value for that font size (multiplied by \baselinestretch).
16
This behavior is extremely difficult to avoid if the equation line is to
remain centered irrespective of the width of the equation number—without
Then the value of
even considering the subjective question of how close is too close for any \baselineskip is saved to the length variable \normalbas
given case!
17
Centering is actually done along the “math axis” (not exactly on the text
baseline, but quite close to it). Many LATEX users are not aware of this minor
2
distinction.
JOURNAL OF LATEX CLASS FILES, VOL. 14, NO. 8, AUGUST
2
elineskip (so that the normal value can be later referenced

size) is different. The commands which are executed within
even if \baselineskip is set to another value by the user). the optional argument are contained within their own
However, if the top of a line ever gets closer than \lineski environment so as not to have any effects outside of the \
plimit to the bottom of the line above it, the use of \basel
IEEEeqnarra ystrutsize command. For mimicking the
ineskip will be suspended and \lineskip spacing will be
action of \bas elineskip, the typically recommended
placed between the two lines.18 height and depth of struts is 70% and 30%, respectively, of \
This system works well for text. However, for mathematics,
normalbaselines kip22. \IEEEeqnarraystrutsize
whose symbols have a much higher dynamic range of heights
will assume these values if its height and/or depth arguments
and depths, it is usually better to go ahead and always add an
are left blank. e.g., in the previous example, the strut depth
extra fixed amount of space (\jot) as mentioned in Appendix will be set to 30% of \nor malbaselineskip for the large
F-F. font size.
When the IEEEeqnarray family is loaded, a new length There is also a
command is defined, \IEEEnormaljot, which stores the
nominal value of \jot19, so that this can be always be \IEEEeqnarraystrutsizeadd{height}{depth}[decl]
referred to even if other values are currently being used.
command which will add to the current default strut values
At the start of \IEEEeqnarray/box, but before the local
and can be used much like the \extrarowheight parameter
or global controls, the following initialization takes place:
of the array.sty package. Empty arguments are assumed to be
\lineskip=0pt 0 pt.
\lineskiplimit=0pt
\baselineskip=\normalbaselineskip \IEEEeqnarraystrutsize and \
\jot=\IEEEnormaljot IEEEeqnarraystruts izeadd can also be used at the end
of the last column to alter the strut size used for a particular
Thus, \baselineskip is set to the normal value for the
row (the default strut values of the other rows will not be
current font, \jot is restored to its nominal value and the
affected).
\lineskiplimit system is disabled.20
There is also a
This system is designed to better facilitate nested IEEEeq-
narraybox structures as well as to help prevent the user from \IEEEstrut[height][depth][decl]
encountering seemingly uncontrollable spacing behavior (e.g.,
“How do I get rid of that unwanted space?!”). which produces a strut. It can be used whenever a “manual”
strut is needed—even outside the \IEEEeqnarray/box en-
vironments. If a height or depth argument is not provided (or
I. The IEEEeqnarray Strut System empty) then these will be assumed in the same way as \IEEE
When creating tables, especially tables with vertical rules, eqnarraystrutsize does.
vertical space between the rows of the table is not generally For diagnostic purposes (in order to see if any row objects
desirable because such space will suspend the column cell exceed the height of the struts), the command \IEEEvisibl
definitions and “cut across” any vertical rules that may be estrutstrue can be placed with an \IEEEeqnarray/box
present. Yet, there must be a way to keep rows adequately or \IEEEstrut control to make the struts visible.
spaced apart. To solve this problem, the IEEEeqnarray/box When using \IEEEeqnarraybox to produce tables that
commands provide an integrated system to manage struts 21 contain vertical lines, it is usually desirable to shutdown the
contained in a hidden column on the right end of each \baselineskip system and switch over to pure strut
IEEEeqnarray/box structure. spacing. The following command sequence, placed within a
The struts in each row will be set to a default strut height local or global control, will serve this purpose:
and depth. Normally, the default strut height and depth are
\IEEEeqnarraystrutsize{0.7\normalbaselineskip}{0.3\n
initialized to zero, so the struts will effectively not be present. ormalbaselineskip}[\relax]
The user can set the default strut values via the \setlength{\baselineskip}{0pt}%
\setlength{\lineskip}{0pt}%
\IEEEeqnarraystrutsize{height}{depth}[decl]
\setlength{\lineskiplimit}{0pt}%
command which can be placed in a local or global control. \setlength{\jot}{0pt}%
The optional argument is for commands that will be executed Note the use of “%” to prevent the ends of the lines that end
prior to the evaluation of the height and depth arguments. in braces from being interpreted as unwanted spaces. Because
Thus, of the frequent need to call this sequence, the IEEEeqnarray
\IEEEeqnarraystrutsize{0.5\baselineskip}{}[\large] family provides the \IEEEeqnarraystrutmode command
will set the default strut height to half the baselineskip used by which does the same thing.
the large font size, even if the current baselineskip (and/or font
18
Within IEEEtran.cls, \lineskiplimit and \lineskip are zero—
J. Overriding Column Types
if things get too close it is the author’s responsibility to correct the problem Within a row, one or more column types can be overridden
without having IEEEtran.cls second guessing the author’s intent.
19
Within IEEEtran.cls, the nominal value of \jot is 25% of the baseli-
by placing the command
neskip for the normalsize font. \IEEEeqnarraymulticol{num_cols}{col_type}{text}
20
As long as rows cannot be of negative height.
21
“Struts” are vertical rules of zero width, but of finite height. 22
Note that this not the normalsize baselineskip, but the normal
baselineskip for the current font size.
as the very first command in a cell. This command is the incompatible way. The IEEEeqnarray family provides its own
IEEEeqnarray equivalent of \multicolumn. The first argu- version of \vline:
ment is the number of columns to override (cutting through
\IEEEeqnarrayvrule[rule_thickness]
any inter-column glues as needed). The second argument is
the column type specifier to use. The third argument contains that produces a vertical rule extending from the top to bottom
the cell text. The third argument will have to be enclosed of a cell without overriding the column type. The optional
within an extra set of braces if the column type is to acquire it argument is for specifying the rule thickness which defaults
as an argument—as was done with the “myp” parbox column to \arrayrulewidth if no argument is provided.
type in the example earlier (Appendix F-B). The IEEEeqnarray row commands (discussed in the next
There is also the \IEEEeqnarrayomit command which, section) provide some alternatives to \hline.
when used as the very first command in a cell, will suspend
the use of the normal column type for that cell. This is
L. Row Commands
somewhat like a quicker version of \
IEEEeqnarraymulticol{1}{x} The IEEEeqnarray family has several commands which can
{}. be used to produce special rows that span all the columns.
Users are cautioned not to use commands like these (e.g., Unless otherwise noted, the commands described here must
\multicolumn) that are designed for other alignment envi- issued as the very first command in a given row.
ronments.23 To produce a spacer row that relies on the strut system, use
\IEEEeqnarrayseprow[height][decl]
K. Predefined Column Types for Rules The first argument specifies the height of the strut row, if left
Several of the predefined column types produce vertical or blank or empty, the default value of 0.25\normalbaseli
horizontal lines. Note that, in the IEEEeqnarray family, rules neskip will be assumed. The second optional argument is
are declared and treated as normal column types—they are not for commands which will be executed prior to the evaluation
hidden. Although this approach may increase the number of of the first argument as is done with \IEEEeqnarraystrut
columns the user has to keep track of, especially when size. \IEEEeqnarrayseprow will not interrupt the column
creating tables, it does offer a great deal of flexibility by definitions, so it will not cut vertical lines. If column
allowing the user to override, or otherwise manipulate, any definition suspension is desired, use the cutting form which
column type (including those that produce rules) at will. will override all the column types in the entire row:
All of the predefined rule column types use the \arrayru \IEEEeqnarrayseprowcut[height][decl]
lewidth length to determine the line thickness and \doubl
To produce a horizontal rule row, use:
erulesep for the spacing of double rules.
The “v” column type produces a vertical rule, “vv” \IEEEeqnarrayrulerow[rule_thickness]
produces two back-to-back vertical rules which will appear which will override all the column definitions with one that
as one rule of twice the normal thickness. “V” produces a produces a horizontal rule. If the optional rule thickness is not
double vertical rule with \doublerulesep spacing between specified, the value of \arrayrulewidth will be used.
its two lines. “VV” produces two back-to-back double vertical To produce a double rule row, use:
rules which will appear to be three vertical rules, the middle
\IEEEeqnarraydblrulerow[rule_thickness][spacing]
one of which being twice as thick as the other two. It is
possible to “spread apart” the “vv” and “VV” types by placing which will produce a rule row, a (noncutting) separation row,
a spacer within their columns—thus they can be used to followed by another rule row. If the optional rule thickness is
generate two single, or double, vertical rules whose separation not specified, the value of \arrayrulewidth will be used
distance is programmable. when producing each of the two rule rows. If the optional
The “h” and “H” types produce single and double horizontal separation distance is not specified, the value of \doubleru
rules, respectively. Horizontal rule types are not normally used lesep will be used. There is also a cutting form:
in the column specifications, but rather with the \IEEEeqna \IEEEeqnarraydblrulerowcut[rule_thickness][spacing]
rraymulticol command in order to draw a horizontal rule
across one or more column(s). which works the same way except that the separation row
Please be aware that the line commands of other alignment will override all the column definitions. (Vertical rule columns
environments may not work properly within the IEEEeqnarray will not appear inside the double rule row produced by this
family which provides its own ways of doing these types of command.)
things. In particular, \cline is totally incompatible—users
should use the \IEEEeqnarraymulticol{num_cols}{h} M. Useful Low Level TEX Commands
{} command instead. However, \vline and \hline should
Although the use of lower level TEX commands is
work—unless another LATEX package redefines them in generally frowned upon in LATEX, some of them are just too
some helpful to ignore.
23 \phantom{} produces an invisible box with the width,
Those who are familiar with TEX may be interested in the fact that
TEX’s height and depth of its contents, but the contents themselves
\omit, \span and \multispan should work in \IEEEeqnarraybox,
but not in \IEEEeqnarray because of the need to track column usage with
a hidden counter in the latter.
2
will not appear in the output. There is also the \hphantom So, the line spacing controls of the IEEEeqnarray commands
{} and \vphantom{} forms which retain only the contents’ will not be in effect. The user may have to manually add \bas
width, or its height and depth, respectively. As an example, elineskip and/or \jot spacing as needed (which was done
look carefully at the footnotes at the bottom of Table V. This in the previous example). (2) Furthermore, \noalign does
table was produced using the \IEEEeqnarraybox not automatically place its contents within a box. However,
command. The footnotes are actually contained within the last nonaligned material must be placed within a horizontal box
two rows of the table. Note how the left sides of the when within the vertical box produced by the \IEEEeqnarr
footnotes line up, even though the first one has a superscript aybox command. Therefore, when using \noalign within
asterisk for a footnote symbol. The reason that the second row a \IEEEeqnarraybox, be sure to wrap things up in an
lines up is because, at its left side, it employs a horizontal \hbox{}:24
phantom of the very same symbol:
\noalign{\hbox{and therefore}}
\hphantom{\textsuperscript{*}}
(3) Finally, there may be some issues related to how easily
Vertical phantoms can be used to equalize row height or page breaks occur around the \noalign lines. This is an
spacing—such as to get matrices that fit within brackets of issue only with \IEEEeqnarray because page breaks cannot
the same size even though one has “tall” symbols and the
occur within the box produced by \IEEEeqnarraybox. If
other not.
needed, page break desirability can be altered by manually
The opposite of \hphantom{} is \rlap{} which
entering
displays its contents, but with zero width. There is also an \
\pagebreak, or \nopagebreak, etc., at the end of the \no
llap{} which does the same thing, but the contained object
align contents.
will appear just to the left of the given point, rather than
after as with
\rlap. For example, look closely at the first “Width” column N. More Practical Examples of Use
heading in Table V. The word “Width” is centered irrespective The use of the IEEEeqnarray is somewhat complicated.
of the asterisk. That is because the width of the asterisk was However, once the building blocks and core concepts are
zeroed: understood, the user may find that is easier to use the
Width\rlap{\textsuperscript{*}} IEEEeqnarray family for just about every alignment situation
rather than to have to remember all the interfaces and unique
The vertical analog of \rlap is \smash{} which reduces behaviors of many different tools.
the apparent height and depth of its contents to zero. A few “real world” examples will now be demonstrated.
(LATEX’s
1) IEEEeqnarray Cases Structures: Cases structures can be
\raisebox{0pt}[0pt][0pt]{} does about the same thing,
obtained using \IEEEeqnarraybox:
and also provides an adjustable vertical offset.) \smash can
be used when space is already reserved for an object, but x, for x ≥ 0
|x| = (13)
that LATEX does not “know” this and would allocate −x, for x < 0
unwanted additional vertical space. One good use of smash for
tableobjects that are to be “slipped” into a hidden row of zero which was produced using the code:
height, or into a row which is to be no higher than the “short” \begin{equation}
things, such as horizontal rules, that are in its other columns. \setlength{\nulldelimiterspace}{0pt}
The TEX \noalign{} command can be used within IEEEe- |x|=\left\{\begin{IEEEeqnarraybox}[\relax][c]{l’s}
x,&for $x \geq 0$\\
qnarray family to inject text which is outside of the alignment -x,&for $x < 0$%
structure. For example, \end{IEEEeqnarraybox}\right.
\end{equation}
\begin{IEEEeqnarray}{rCl} A_1&=&7\IEEEyesnumber\
IEEEyessubnumber\\ A_2&=&b+1\IEEEyessubnumber\\
Note the use of the large \quad (1 em) spacing before the
\noalign{\noindent and\vspace{\jot}}A_3&=&d+2\IEEEye
ssubnumber% conditional statements. The zeroing of \nulldelimiterspa
\end{IEEEeqnarray} ce, an optional step, eliminates the width of the nonvisible
closing brace “\right.” in order to perfectly center the
produces
visible portion of the equation.25
A1 = 7 (12a) Note that both branches share a common equation number.
A2 = b + 1 (12b) If an equation (sub)number is wanted for each branch, the
and preferred solution is to use the cases.sty package as discussed
in Section IX-A. However, it is possible to use \IEEEeqnar
A3 = d + 2 (12c) ray to build such a thing—although it takes extra work and
When employed, \noalign must be the very first com- a few tricks to do so. For example,
mand in a row—even before any \IEEEeqnarraymulticol,
\IEEEeqnarrayomit, or row commands. x, for x ≥ 0 (14a)
x| =
|
−x, for x < 0 (14b)
Be forewarned that the proper use of \noalign can be
tricky. There are three potential issues. (1) Remember that 24 A
L TEX’s \mbox will not work!
\noalign will place its contents outside of the 25
The width of null delimiters is typically only 1.2 pt, and so can usually
alignment. be safely ignored.
was produced using the code: TABLE VI

\begin{IEEEeqnarray}[\setlength{\nulldelimiterspace} NETWORK DELAY AS A FUNCTION OF LOAD
{0pt}]{rl’s}
&x,&for $x \geq 0$\IEEEyesnumber\IEEEyessubnumber\\* Average Delay
β λmin λmax
[-0.625\normalbaselineskip]
\smash{|x|=\left\{\IEEEstrut[3\jot][3\jot]\right.}&& 1 0.057 0.172
\nonumber\\*[-0.625\normalbaselineskip]
&-x,&for $x < 0$\IEEEyessubnumber 10 0.124 0.536
\end{IEEEeqnarray} 100 0.830 0.905*
*
limited usability
A hidden middle row is used to hold the left hand side of
the equality. In order to prevent this row from altering the
spacing between the two branches, its height must be smashed
and the extra line spacing (which consists of \baselinesk [c]{,c/c,}
ip, plus \jot which is normally 0.25\baselineskip for 1/2&0\\
0&3/4%
IEEEtran.cls.) must be removed, half from above and half \end{IEEEeqnarraybox*}\right]
\end{equation}
from below,—making it look as though the middle row never
occurred. Because the large brace cannot “see” the height of The use of a user defined command, \mysmallarrayde
the branches, it must be manually sized with a strut. The cl, to contain the IEEEeqnarray setup code, demonstrates
star form of the new line commands is used to prevent the how users can easily recreate their most commonly used
possibility of a page break within the structure. structures by fully exploiting the on-the-fly configurability of
2) Matrices: Displayed matrices can easily be created with the IEEEeqnarray family.
\IEEEeqnarraybox: This example is more complex than need be in order to
1 00 demonstrate a few techniques. It would be easy enough to set
I= 0 10 (15) \baselineskip to the desired value, but suppose that the
0 0 1 matrix rows are to be spaced some multiple of the \baselin
The code of this example is quite simple: eskip of the \scriptsize font. Complicating matters even
\begin{equation}
more is the fact that most LATEX class files will not allow
I = \left(\ the user to execute text font size commands within math mode
begin{IEEEeqnarraybox*}[][c]{,c/c/c,} 1&0&0\\ — and the matrix is within an equation. So, \scriptsize
0&1&0\\
0&0&1%
cannot be used to directly set the \baselineskip.
\end{IEEEeqnarraybox*}\right) The first step is to set the math and text columns to
\end{equation} their desired styles. Then \baselinestretch is setup to be
Because the example matrix has elements of normal height, used like \arraystretch. The trick is to run \scriptsize
one can use the star form of \IEEEeqnarraybox to turn off within a \settowidth command which stores the \basel
the extra \jot component of the line spacing so as to make ineskip of the \scriptsize font, multiplied by \baseli
a more compact matrix. If larger symbols had been used in nestretch, in \normalbaselineskip which is then used
the matrix, the nonstar form would be the better choice. \ar to set \baselineskip, \jot, etc. Finally, \arraycolsep
raycolsep typically serves quite well as an element column is reduced to better suit the smaller font. Note the use of “%”
separator. A standard small math space is added to the ends to prevent unwanted spaces from appearing after the braces at
of the matrix to provide a little distance between it and its the end of lines in \mysmallarraydecl.
enclosing parentheses. 3) Tables: Tables, especially those with lines, tend to be a
It is instructive to show how to construct a “small” matrix26, little more complicated. Table VI was made with the following
code:
S= 1/2 0
(16)
0 3/4 \begin{table}[!t]
\centering
which was produced via \caption{Network Delay as a Function of Load}
\label{table_delay}
\newcommand{\mysmallarraydecl}{\renewcommand{% \begin{IEEEeqnarraybox}[\IEEEeqnarraystrutmode\IEEEe
\IEEEeqnarraymathstyle}{\scriptscriptstyle}% qnarraystrutsizeadd{2pt}{0pt}]{x/r/Vx/r/v/r/x}
\renewcommand{\IEEEeqnarraytextstyle}{\scriptsize}% \IEEEeqnarraydblrulerowcut\\ &&&&\
\renewcommand{\baselinestretch}{1.1}% IEEEeqnarraymulticol{3}{t}{Average Delay}&\\ &\
\settowidth{\normalbaselineskip}{\scriptsize hfill\raisebox{-3pt}[0pt][0pt]{$\beta$}\hfill&&\IE
\hspace{\baselinestretch\baselineskip}}% EEeqnarraymulticol{5}{h}{}%
\setlength{\baselineskip}{\normalbaselineskip}% \IEEEeqnarraystrutsize{0pt}{0pt}\\ &&&&\hfill\
\setlength{\jot}{0.25\normalbaselineskip}% lambda_{\mbox{min}}\hfill&&\hfill
\setlength{\arraycolsep}{2pt}} \lambda_{\mbox{max\vphantom{i}}}\hfill&\IEEEeqnarray
% strutsizeadd{0pt}{2pt}\\
\begin{equation} S=\left[\begin{IEEEeqnarraybox*}[\ \IEEEeqnarraydblrulerowcut\\
mysmallarraydecl] &1&&& 0.057&& 0.172&\\
&10&&& 0.124&& 0.536&\\
26
IEEE authors should note that the use of small matrices is not recom- &100&&& 0.830&& 0.905\rlap{\textsuperscript{*}}&\\
mended as the IEEE does not usually reduce font sizes in equations or alter \IEEEeqnarraydblrulerowcut\\
the main text baselineskip to accommodate in-text mathematics. &\IEEEeqnarraymulticol{7}{s}{\scriptsize\textsupersc
3
TABLE VII \IEEEeqnarraydblrulerow\\

POSSIBLE Ω FUNCTIONS \IEEEeqnarrayseprow[3pt]\\
&x < 0&&\Omega(m)=\sum\limits_{i=0}^{m}K^{-i}&\IEEEe
Range Ω(m) qnarraystrutsize{0pt}{0pt}\\
m \IEEEeqnarrayseprow[3pt]\\
\IEEEeqnarrayrulerow\\
x<0 Ω(m) = K−i
\IEEEeqnarrayseprow[3pt]\\
i=0
√ &x \ge 0&&\Omega(m)=\sqrt{m}\hfill&\IEEEeqnarraystru
x≥0 Ω(m) = m tsize{0pt}{0pt}\\
\IEEEeqnarrayseprow[3pt]\\
\IEEEeqnarrayrulerow
\end{IEEEeqnarraybox}
ript{*}limited usability}% \end{table}
\end{IEEEeqnarraybox}
\end{table} The solution is to use \IEEEeqnarrayseprow to manually
add in a fixed amount of extra space as needed. In this way,
Because this table has lines, the first step is to enable strut
\IEEEeqnarrayseprow can do for lined tables what \jot
mode line spacing. The strut height is then increased by a
does for multiline equations. Of course, using this method, the
couple of points to provide a little more headroom above the
baselines of the rows will no longer be equally spaced.
letters.27 This table uses cutting horizontal rules and open
The \hfill in the square root cell is a cheap, but effective,
sides as is commonly done in IEEE publications. There are
way of getting the equal signs to line up without the need of
three extra “x” columns which serve as place holders. The
additional columns.
“x” columns at each end serve as a quick way to get the
horizontal rules to extend a little past the contents of the table.
The middle “x” column serves as an attachment point for the ACKNOWLEDGMENT
horizontal rule that is below “Average Delay”. Without this The author would like to thank Ken Rawson, Kevin
extra column, the left side of that horizontal rule would cut Lisankie, Kimberly Sperka, Steve Wareham, Patrick Kellen-
into the middle double vertical rule.28 Notice how the “β” is berger, Laura Hyslop and Cathy Cardon of the IEEE for their
smuggled in as part of the row containing the horizontal rule. help and support in making this work possible. The knowledge
β has to be smashed so that it will not add unwanted vertical and prior work of TEX gurus such as Donald Arseneau,
spacing. Likewise, the strut for that row is disabled. Also, \ra Fred Bartlett, David Carlisle, Tony Liu, Frank Mittelbach,
isebox is used instead of \smash so that β can be vertically Piet van Oostrum, Roland Winkler and Mark Wooding were
lowered—otherwise it would appear on its baseline which is instrumental in developing the complex IEEEeqnarray family
too high for the purpose at hand. The \hfill on either side of commands. The author is also grateful to Peter Wilson and
of β changes the justification of that cell to centered. The Donald Arseneau for allowing the inclusion of their \@ifmt
“min” and “max” subscripts would not normally sit at the arg command.
same level because the “i” in min is slightly higher than the Finally, this work might not have been possible had it
letters in “max”. To fix this, a \vphantom “i” is added to not been for the efforts of the prior IEEEtran developers:
“max”. Because these subscripts sit so low, the depth of that Gerry Murray, Silvano Balemi, Jon Dixion, Peter Nüchter and
line’s strut is increased a couple of points. Alternatively, one Juergen von Hagen. Their work still lives on to some degree
could have just smashed the “i”. The asterisk next to “0.905” within IEEEtran.
is reduced to zero width via \rlap so that it will not affect its
cell’s width or alignment. This example also illustrates how REFERENCES
to integrate table footnotes into the end of a table without the [1] (2015, Jul.) The IEEE website. [Online]. Available: http://www.ieee.org/
help of external packages. [2] M. Shell. (2015, Aug.) The IEEEtran.cls package. [Online]. Available:
Strut spacing does not work so well for rows that contain http://www.ctan.org/pkg/ieeetran
tall symbols because such objects routinely exceed the height [3] ——. (2015, Jul.) IEEEtran homepage. [Online]. Available: http:
//www.michaelshell.org/tex/ieeetran/
of the struts. Furthermore, increasing the strut height is often [4] H. Kopka and P. W. Daly, Guide to LATEX, 4th ed. Harlow,
not an option because (1) the height and depth of the tall England: Addison-Wesley, 2003.
symbols must be measured or guessed; and (2) there may be [5] T. Oetiker, H. Partl, I. Hyna, and E. Schlegl. (2015, Jul.) The not so
short introduction to LATEX 2ε . [Online]. Available:
other rows which have normal line height. Table VII illustrates http://www.ctan.org/pkg/lshort
such a situation. Its code is shown here: [6] S. M. Moser. (2013, Aug.) How to Typeset Equations in
LATEX. [Online]. Available:
\begin{table}[!t] http://moser.cm.nctu.edu.tw/manuals.html#eqlatex
\centering [7] R. Fairbairns. (2014, Jun.) The TEX FAQ. [Online]. Available:
\caption{Possible $\Omega$ Functions} http://www.tex.ac.uk/
\label{table_omega} [8] M. Sharpe. (2015, Jul.) The newtx package. [Online]. Available:
\begin{IEEEeqnarraybox}[\IEEEeqnarraystrutmode\IEEEe http://www.ctan.org/pkg/newtx
qnarraystrutsizeadd{2pt}{1pt}]{v/c/v/c/v} [9] (2015, Jul.) Mathtime professional fonts. Personal TEX, Inc. [Online].
\IEEEeqnarrayrulerow\\ &\mbox{Range}&&\ Available: http://www.pctex.com/mtpro2.html
Omega(m)&\\ [10] D. Carlisle and F. Mittelbach. (2015, Apr.) The bm package. [Online].
Available: http://www.ctan.org/pkg/bm
27 [11] (2013, Jan.) The amsmath package. The American Mathematical
Knuth calls this extra step a mark of quality.
28
Some may even think it would be better that way, but we want to show Society. [Online]. Available: http://www.ctan.org/pkg/amsmath
some tricks in these examples. [12] S. Pakin. (2009, Apr.) The IEEEconf.cls package. [Online]. Available:
http://www.ctan.org/pkg/ieeeconf
[13] J. D. McCauley, J. Goldberg, and A. Sommerfeldt. (2011, Dec.) The [30] D. Carlisle. (1999, Apr.) The fix2col package. [Online]. Available:
endfloat package. [Online]. Available: http://www.ctan.org/pkg/endfloat http://www.ctan.org/pkg/fix2col
[14] H. Oberdiek. (2012, May) The ifpdf package. [Online]. Available: [31] M. Høgholm. (2012, Dec.) The dblfloatfix package. [Online]. Available:
http://www.ctan.org/pkg/ifpdf http://www.ctan.org/pkg/dblfloatfix
[15] A. Gefen, “Simulations of foot stability during gait characteristic of [32] M. Shell. (2015, Aug.) The IEEEtran BIBTEX style. [Online]. Available:
ankle dorsiflexor weakness in the elderly,” IEEE Trans. Neural Syst. http://www.ctan.org/pkg/ieeetran
Rehab. Eng., vol. 9, no. 4, pp. 333–337, Dec. 2001. [33] P. W. Daly. (2013, May) The balance package. [Online]. Available:
[16] D. Arseneau. (2015, Mar.) The cite package. [Online]. Available: http://www.ctan.org/pkg/balance
http://www.ctan.org/pkg/cite [34] S. Tolušis and V. Statulevicˇius. (2015, Apr.) The flushend
[17] M. D. Wooding. (1999, Mar.) The MDW tools package. [Online]. package. [Online]. Available: http://www.ctan.org/pkg/flushend
Available: http://www.ctan.org/pkg/mdwtools [35] M. Shell. (2007, Jan.) The testflow diagnostic suite. [Online]. Available:
[18] D. Arseneau. (2010, Feb.) The cases package. [Online]. Available: http://www.ctan.org/pkg/testflow
http://www.ctan.org/pkg/cases [36] T. Oetiker. (2015, Mar.) The acronym package. [Online]. Available:
[19] S. Tolušis and V. Statulevicˇius. (2013, Oct.) The stfloats http://www.ctan.org/pkg/acronym
package. [Online]. Available: http://www.ctan.org/pkg/stfloats [37] D. Arseneau. (2013, Dec.) The url package. [Online]. Available:
[20] D. Carlisle. (2015, Apr.) Packages in the ‘graphics’ bundle. http://www.ctan.org/pkg/url
grfguide.pdf. [Online]. Available: http://www.ctan.org/pkg/graphics [38] M. Shell. (2015, Aug.) The IEEEtrantools package. [Online]. Available:
[21] K. Reckdahl. (2006, Jan.) Using imported graphics in LATEX http://www.ctan.org/pkg/ieeetrantools
2ε . [Online]. Available: http://www.ctan.org/pkg/epslatex
[22] C. Barratt, M. C. Grant, and D. Carlisle. (1998, May) The psfrag
package. [Online]. Available: http://www.ctan.org/pkg/psfrag
[23] S. D. Cochran. (2005, Jul.) The subfigure package. [Online]. Available:
http://www.ctan.org/pkg/subfigure Michael Shell (M’87) received the B.E.E., M.S.E.E.
[24] S. D. Cochran, V. Karen-Pahlav, Z. Mehran, and V. Khalighi. (2005, Jul.) and Ph.D. degrees in electrical engineering all from
The subfig package. [Online]. Available: http://www.ctan.org/pkg/subfig the Georgia Institute of Technology, Atlanta, in
[25] A. Sommerfeldt. (2013, May) The subcaption package. [Online]. 1991, 1993 and 2004 respectively. He has developed
Available: http://www.ctan.org/pkg/subcaption several all-optical packet-switched network subsys-
[26] P. Williams and R. Brito. (2009, Aug.) The algorithmic package. tems and node demonstrations. His research
[Online]. Available: http://www.ctan.org/pkg/algorithms interests include all-optical packet-switched
[27] S. János. (2005, Apr.) The algorithmicx.sty package. [Online]. networks, high speed opto-electronic interface
Available: http://www.ctan.org/pkg/algorithmicx design, discrete simulation and exact Markov
[28] F. Mittelbach and D. Carlisle. (2015, Apr.) The array package. [Online]. models for buffered packet switches.
Available: http://www.ctan.org/pkg/array Dr. Shell is also the author of the most recent
[29] D. Arseneau. (2010, Mar.) The threeparttable package. [Online]. versions of the IEEEtran LATEX class and BIBTEX style packages and
Available: http://www.ctan.org/pkg/threeparttable is the
current maintainer of both.

IEEEtran HOWTO PDF

Uploaded by

Document Informationclick to expand document informationIEEE HOW TO

Document Informationclick to expand document information

Copyright:

Available Formats

IEEEtran HOWTO PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IEEEtran HOWTO PDF

Uploaded by

Copyright:

Available Formats

JOURNAL OF LATEX CLASS FILES, VOL. 14, NO.

How to Use the IEEEtran LATEX Class

W ITH a recent IEEEtran class file, a computer running

B. draft, draftcls, draftclsnofoot, final

end of the document. Such figure placement can be achieved

Use \and to separate the affiliation columns. The columns

\IEEEaftertitletext{\vspace{-1\baselineskip}} To facilitate dual compilation, IEEEtran provides another

VIII. E QUATIONS Another extremely powerful set of alignment tools, one

\label{fig_sim} It is important to note that subfig.sty package options are

TABLE II TABLE III

EEilabelindentA and the longer as \IEEEilabelindent

\begin{enumerate}[\IEEEsetlabelwidth{12)}] Sometimes it is desirable that a structure share its counter

The mandatory argument to section can be left blank ( \sect

There are LATEX packages, such as balance.sty [33] initexmf -u

APPENDIX D Some IEEE conferences may be more liberal with regard to

APPENDIX F prevent the LATEX parser from

Virtually all LATEX alignment commands such as \

The optional argument is for commands that are to be

IEEEEQNARRAY PREDEFINED COLUMN TYPES

I.D. Description I.D. Description

I.D. Width* I.D. Width

becoming confused, the contents of an optional argument

numbers to the right of the last specified column. Currently,

The \IEEEyesnumber command increments the equation

elineskip (so that the normal value can be later referenced

was produced using the code: TABLE VI

TABLE VII \IEEEeqnarraydblrulerow\\

You might also like